androidtv Documentation

androidtv

androidtv package

Submodules

androidtv.androidtv module

Communicate with an Android TV device via ADB over a network.

ADB Debugging must be enabled.

class androidtv.androidtv.AndroidTV(host, adbkey='', adb_server_ip='', adb_server_port=5037)

Bases: androidtv.basetv.BaseTV

Representation of an Android TV device.

DEVICE_CLASS = 'androidtv'

audio_state

Check if audio is playing, paused, or idle.

Returns:The audio state, as determined from the ADB shell command dumpsys audio, or None if it could not be determined Return type:str, None

device

Get the current playback device.

Returns:The current playback device, or None if it could not be determined Return type:str, None

get_properties(lazy=False)

Get the properties needed for Home Assistant updates.

Parameters:lazy (bool) – Whether or not to continue retrieving properties if the device is off or the screensaver is running Returns:

• screen_on (bool, None) – Whether or not the device is on, or None if it was not determined
• awake (bool, None) – Whether or not the device is awake (screensaver is not running), or None if it was not determined
• wake_lock_size (int, None) – The size of the current wake lock, or None if it was not determined
• media_session_state (int, None) – The state from the output of dumpsys media_session, or None if it was not determined
• current_app (dict, None) – The current app property, or None if it was not determined
• audio_state (str, None) – The audio state, as determined from “dumpsys audio”, or None if it was not determined
• device (str, None) – The current playback device, or None if it was not determined
• muted (bool, None) – Whether or not the volume is muted, or None if it was not determined
• volume_level (int, None) – The absolute volume level, or None if it was not determined

get_properties_dict(lazy=True)

Get the properties needed for Home Assistant updates and return them as a dictionary.

Parameters:lazy (bool) – Whether or not to continue retrieving properties if the device is off or the screensaver is running Returns:A dictionary with keys 'screen_on', 'awake', 'wake_lock_size', 'media_session_state', 'current_app', 'audio_state', 'device', 'muted', and 'volume_level' Return type:dict

muted

Whether or not the volume is muted.

Returns:Whether or not the volume is muted, or None if it could not be determined Return type:bool, None

start_intent(uri)

Start an intent on the device.

Parameters:uri (str) – The intent that will be sent is am start -a android.intent.action.VIEW -d <uri>

turn_off()

Send POWER action if the device is not off.

turn_on()

Send POWER action if the device is off.

update()

Get the info needed for a Home Assistant update.

Returns:

• state (str) – The state of the device
• current_app (str) – The current running app
• device (str) – The current playback device
• muted (bool) – Whether or not the volume is muted
• volume (float) – The volume level (between 0 and 1)

volume

Get the relative volume level.

Returns:The volume level (between 0 and 1), or None if it could not be determined Return type:float, None

volume_level

Get the absolute volume level.

Returns:The absolute volume level, or None if it could not be determined Return type:int, None

androidtv.basetv module

Communicate with an Android TV or Amazon Fire TV device via ADB over a network.

ADB Debugging must be enabled.

class androidtv.basetv.BaseTV(host, adbkey='', adb_server_ip='', adb_server_port=5037)

Bases: object

Base class for representing an Android TV / Fire TV device.

_adb_shell_pure_python_adb(cmd)

Send an ADB command using an ADB server.

Parameters:cmd (str) – The ADB command to be sent Returns:The response from the device, if there is a response Return type:str, None

_adb_shell_python_adb(cmd)

Send an ADB command using the Python ADB implementation.

Parameters:cmd (str) – The ADB command to be sent Returns:The response from the device, if there is a response Return type:str, None

_key(key)

Send a key event to device.

Parameters:key (str, int) – The Key constant

available

Check whether the ADB connection is intact.

Returns:Whether or not the ADB connection is intact Return type:bool

awake

Check if the device is awake (screensaver is not running).

Returns:Whether or not the device is awake (screensaver is not running) Return type:bool

back()

Send back action.

connect(always_log_errors=True)

Connect to an Android TV / Fire TV device.

Parameters:always_log_errors (bool) – If True, errors will always be logged; otherwise, errors will only be logged on the first failed reconnect attempt Returns:Whether or not the connection was successfully established and the device is available Return type:bool

current_app

Return the current app.

Returns:A dictionary with keys 'package' and 'activity' if the current app was found; otherwise, None Return type:dict

down()

Send down action.

enter()

Send enter action.

get_device_properties()

Return a dictionary of device properties.

Returns:props – A dictionary with keys 'wifimac', 'ethmac', 'serialno', 'manufacturer', 'model', and 'sw_version' Return type:dict

home()

Send home action.

key_0()

Send 0 keypress.

key_1()

Send 1 keypress.

key_2()

Send 2 keypress.

key_3()

Send 3 keypress.

key_4()

Send 4 keypress.

key_5()

Send 5 keypress.

key_6()

Send 6 keypress.

key_7()

Send 7 keypress.

key_8()

Send 8 keypress.

key_9()

Send 9 keypress.

key_a()

Send a keypress.

key_b()

Send b keypress.

key_c()

Send c keypress.

key_d()

Send d keypress.

key_e()

Send e keypress.

key_f()

Send f keypress.

key_g()

Send g keypress.

key_h()

Send h keypress.

key_i()

Send i keypress.

key_j()

Send j keypress.

key_k()

Send k keypress.

key_l()

Send l keypress.

key_m()

Send m keypress.

key_n()

Send n keypress.

key_o()

Send o keypress.

key_p()

Send p keypress.

key_q()

Send q keypress.

key_r()

Send r keypress.

key_s()

Send s keypress.

key_t()

Send t keypress.

key_u()

Send u keypress.

key_v()

Send v keypress.

key_w()

Send w keypress.

key_x()

Send x keypress.

key_y()

Send y keypress.

key_z()

Send z keypress.

left()

Send left action.

manufacturer

Get the ‘manufacturer’ property from the device.

Returns:The manufacturer of the device Return type:str, None

media_next()

Send media next action (results in fast-forward).

media_pause()

Send media pause action.

media_play()

Send media play action.

media_play_pause()

Send media play/pause action.

media_previous()

Send media previous action (results in rewind).

media_session_state

Get the state from the output of dumpsys media_session.

Returns:The state from the output of the ADB shell command dumpsys media_session, or None if it could not be determined Return type:int, None

media_stop()

Send media stop action.

menu()

Send menu action.

mute_volume()

Mute the volume.

power()

Send power action.

right()

Send right action.

screen_on

Check if the screen is on.

Returns:Whether or not the device is on Return type:bool

sleep()

Send sleep action.

space()

Send space keypress.

up()

Send up action.

volume_down()

Send volume down action.

volume_up()

Send volume up action.

wake_lock

Check for wake locks (device is playing).

Returns:Whether or not the wake_lock_size property is equal to 1. Return type:bool

wake_lock_size

Get the size of the current wake lock.

Returns:The size of the current wake lock, or None if it could not be determined Return type:int, None

androidtv.constants module

Constants used in the BaseTV, AndroidTV, and FireTV classes.

androidtv.firetv module

Communicate with an Amazon Fire TV device via ADB over a network.

ADB Debugging must be enabled.

class androidtv.firetv.FireTV(host, adbkey='', adb_server_ip='', adb_server_port=5037)

Bases: androidtv.basetv.BaseTV

Representation of an Amazon Fire TV device.

DEVICE_CLASS = 'firetv'

_send_intent(pkg, intent, count=1)

Send an intent to the device.

Parameters:

• pkg (str) – The command that will be sent is monkey -p <intent> -c <pkg> <count>; echo $?
• intent (str) – The command that will be sent is monkey -p <intent> -c <pkg> <count>; echo $?
• count (int, str) – The command that will be sent is monkey -p <intent> -c <pkg> <count>; echo $?

Returns:

A dictionary with keys 'output' and 'retcode', if they could be determined; otherwise, an empty dictionary

Return type:

dict

get_properties(get_running_apps=True, lazy=False)

Get the properties needed for Home Assistant updates.

Parameters:

• get_running_apps (bool) – Whether or not to get the running_apps property
• lazy (bool) – Whether or not to continue retrieving properties if the device is off or the screensaver is running

Returns:

• screen_on (bool, None) – Whether or not the device is on, or None if it was not determined
• awake (bool, None) – Whether or not the device is awake (screensaver is not running), or None if it was not determined
• wake_lock_size (int, None) – The size of the current wake lock, or None if it was not determined
• media_session_state (int, None) – The state from the output of dumpsys media_session, or None if it was not determined
• current_app (dict, None) – The current app property, or None if it was not determined
• running_apps (list, None) – A list of the running apps, or None if it was not determined

get_properties_dict(get_running_apps=True, lazy=True)

Get the properties needed for Home Assistant updates and return them as a dictionary.

Parameters:

• get_running_apps (bool) – Whether or not to get the running_apps property
• lazy (bool) – Whether or not to continue retrieving properties if the device is off or the screensaver is running

Returns:

A dictionary with keys 'screen_on', 'awake', 'wake_lock_size', 'media_session_state', 'current_app', and 'running_apps'

Return type:

dict

launch_app(app)

Launch an app.

Parameters:app (str) – The ID of the app that will be launched Returns:A dictionary with keys 'output' and 'retcode', if they could be determined; otherwise, an empty dictionary Return type:dict

running_apps

Return a list of running user applications.

Returns:A list of the running apps Return type:list

stop_app(app)

Stop an app.

Parameters:app (str) – The ID of the app that will be stopped Returns:The output of the am force-stop ADB shell command, or None if the device is unavailable Return type:str, None

turn_off()

Send SLEEP action if the device is not off.

turn_on()

Send POWER and HOME actions if the device is off.

update(get_running_apps=True)

Get the info needed for a Home Assistant update.

Parameters:get_running_apps (bool) – Whether or not to get the running_apps property Returns:

• state (str) – The state of the device
• current_app (str) – The current running app
• running_apps (list) – A list of the running apps if get_running_apps is True, otherwise the list [current_app]

Module contents

Connect to a device and determine whether it’s an Android TV or an Amazon Fire TV.

ADB Debugging must be enabled.

androidtv.setup(host, adbkey='', adb_server_ip='', adb_server_port=5037, device_class='auto')

Connect to a device and determine whether it’s an Android TV or an Amazon Fire TV.

Parameters:

• host (str) – The address of the device in the format <ip address>:<host>
• adbkey (str) – The path to the adbkey file for ADB authentication; the file adbkey.pub must be in the same directory
• adb_server_ip (str) – The IP address of the ADB server
• adb_server_port (int) – The port for the ADB server
• device_class (str) – The type of device: 'auto' (detect whether it is an Android TV or Fire TV device), 'androidtv', or 'firetv'`

Returns:

aftv – The representation of the device

Return type:

AndroidTV, FireTV

androidtv is a Python 3 package that provides state information and control of Android TV and Fire TV devices via ADB. This package is used by the Android TV integration in Home Assistant.

Installation

Be sure you install into a Python 3.x environment.

pip install androidtv

Acknowledgments

This is based on python-firetv by happyleavesaoc and the androidtv component for Home Assistant by a1ex4, and it depends on python-adb and pure-python-adb.

Indices and tables

• Index
• Module Index
• Search Page