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, state_detection_rules=None)

Bases: androidtv.basetv.BaseTV

Representation of an Amazon Fire 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)

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.

This will send one of the following ADB commands:

• androidtv.constants.CMD_FIRETV_PROPERTIES_LAZY_RUNNING_APPS

• androidtv.constants.CMD_FIRETV_PROPERTIES_LAZY_NO_RUNNING_APPS

• androidtv.constants.CMD_FIRETV_PROPERTIES_NOT_LAZY_RUNNING_APPS

• androidtv.constants.CMD_FIRETV_PROPERTIES_NOT_LAZY_NO_RUNNING_APPS

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

• 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

• 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', 'current_app', 'media_session_state', 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

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]