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, state_detection_rules=None, auth_timeout_s=0.1)[source]

Bases: androidtv.basetv.BaseTV

Representation of an Android TV device.

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

  • adb_server_ip (str) – The IP address of the ADB server

  • adb_server_port (int) – The port for the ADB server

  • state_detection_rules (dict, None) – A dictionary of rules for determining the state (see BaseTV)

  • auth_timeout_s (float) – Authentication timeout (in seconds)

DEVICE_CLASS = 'androidtv'
get_properties(lazy=False)[source]

Get the properties needed for Home Assistant updates.

This will send one of the following ADB commands:

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

  • audio_state (str, None) – The audio state, as determined from “dumpsys audio”, 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

  • current_app (str, None) – The current app property, 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

  • device (str, None) – The current playback device, or None if it was not determined

  • is_volume_muted (bool, None) – Whether or not the volume is muted, or None if it was not determined

  • volume (int, None) – The absolute volume level, or None if it was not determined

get_properties_dict(lazy=True)[source]

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', 'current_app', 'media_session_state', 'audio_state', 'device', 'is_volume_muted', and 'volume'

Return type

dict

start_intent(uri)[source]

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()[source]

Send POWER action if the device is not off.

turn_on()[source]

Send POWER action if the device is off.

update()[source]

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

  • is_volume_muted (bool) – Whether or not the volume is muted

  • volume_level (float) – The volume level (between 0 and 1)