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.

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