androidtv package
Subpackages
- androidtv.adb_manager package
- androidtv.androidtv package
- androidtv.basetv package
- Submodules
- androidtv.basetv.basetv module
BaseTV
BaseTV.DEVICE_ENUM
BaseTV._audio_output_device()
BaseTV._audio_state()
BaseTV._cmd_audio_state()
BaseTV._cmd_current_app()
BaseTV._cmd_current_app_media_session_state()
BaseTV._cmd_hdmi_input()
BaseTV._cmd_launch_app()
BaseTV._cmd_running_apps()
BaseTV._cmd_turn_off()
BaseTV._cmd_turn_on()
BaseTV._cmd_volume_set()
BaseTV._conditions_are_true()
BaseTV._current_app()
BaseTV._current_app_media_session_state()
BaseTV._custom_state_detection()
BaseTV._get_hdmi_input()
BaseTV._get_installed_apps()
BaseTV._is_volume_muted()
BaseTV._parse_device_properties()
BaseTV._parse_getevent_line()
BaseTV._parse_mac_address()
BaseTV._parse_stream_music()
BaseTV._remove_adb_shell_prefix()
BaseTV._running_apps()
BaseTV._screen_on_awake_wake_lock_size()
BaseTV._volume()
BaseTV._volume_level()
BaseTV._wake_lock_size()
BaseTV.available
BaseTV.customize_command()
state_detection_rules_validator()
- androidtv.basetv.basetv_async module
BaseTVAsync
BaseTVAsync._get_stream_music()
BaseTVAsync._key()
BaseTVAsync._send_intent()
BaseTVAsync.adb_close()
BaseTVAsync.adb_connect()
BaseTVAsync.adb_pull()
BaseTVAsync.adb_push()
BaseTVAsync.adb_screencap()
BaseTVAsync.adb_shell()
BaseTVAsync.audio_output_device()
BaseTVAsync.audio_state()
BaseTVAsync.awake()
BaseTVAsync.back()
BaseTVAsync.current_app()
BaseTVAsync.current_app_media_session_state()
BaseTVAsync.down()
BaseTVAsync.enter()
BaseTVAsync.get_device_properties()
BaseTVAsync.get_hdmi_input()
BaseTVAsync.get_installed_apps()
BaseTVAsync.home()
BaseTVAsync.is_volume_muted()
BaseTVAsync.key_0()
BaseTVAsync.key_1()
BaseTVAsync.key_2()
BaseTVAsync.key_3()
BaseTVAsync.key_4()
BaseTVAsync.key_5()
BaseTVAsync.key_6()
BaseTVAsync.key_7()
BaseTVAsync.key_8()
BaseTVAsync.key_9()
BaseTVAsync.key_a()
BaseTVAsync.key_b()
BaseTVAsync.key_c()
BaseTVAsync.key_d()
BaseTVAsync.key_e()
BaseTVAsync.key_f()
BaseTVAsync.key_g()
BaseTVAsync.key_h()
BaseTVAsync.key_i()
BaseTVAsync.key_j()
BaseTVAsync.key_k()
BaseTVAsync.key_l()
BaseTVAsync.key_m()
BaseTVAsync.key_n()
BaseTVAsync.key_o()
BaseTVAsync.key_p()
BaseTVAsync.key_q()
BaseTVAsync.key_r()
BaseTVAsync.key_s()
BaseTVAsync.key_t()
BaseTVAsync.key_u()
BaseTVAsync.key_v()
BaseTVAsync.key_w()
BaseTVAsync.key_x()
BaseTVAsync.key_y()
BaseTVAsync.key_z()
BaseTVAsync.launch_app()
BaseTVAsync.learn_sendevent()
BaseTVAsync.left()
BaseTVAsync.media_next_track()
BaseTVAsync.media_pause()
BaseTVAsync.media_play()
BaseTVAsync.media_play_pause()
BaseTVAsync.media_previous_track()
BaseTVAsync.media_session_state()
BaseTVAsync.media_stop()
BaseTVAsync.menu()
BaseTVAsync.mute_volume()
BaseTVAsync.power()
BaseTVAsync.right()
BaseTVAsync.running_apps()
BaseTVAsync.screen_on()
BaseTVAsync.screen_on_awake_wake_lock_size()
BaseTVAsync.set_volume_level()
BaseTVAsync.sleep()
BaseTVAsync.space()
BaseTVAsync.start_intent()
BaseTVAsync.stop_app()
BaseTVAsync.stream_music_properties()
BaseTVAsync.turn_off()
BaseTVAsync.turn_on()
BaseTVAsync.up()
BaseTVAsync.volume()
BaseTVAsync.volume_down()
BaseTVAsync.volume_level()
BaseTVAsync.volume_up()
BaseTVAsync.wake_lock_size()
- androidtv.basetv.basetv_sync module
BaseTVSync
BaseTVSync._get_stream_music()
BaseTVSync._key()
BaseTVSync._send_intent()
BaseTVSync.adb_close()
BaseTVSync.adb_connect()
BaseTVSync.adb_pull()
BaseTVSync.adb_push()
BaseTVSync.adb_screencap()
BaseTVSync.adb_shell()
BaseTVSync.audio_output_device()
BaseTVSync.audio_state()
BaseTVSync.awake()
BaseTVSync.back()
BaseTVSync.current_app()
BaseTVSync.current_app_media_session_state()
BaseTVSync.down()
BaseTVSync.enter()
BaseTVSync.get_device_properties()
BaseTVSync.get_hdmi_input()
BaseTVSync.get_installed_apps()
BaseTVSync.home()
BaseTVSync.is_volume_muted()
BaseTVSync.key_0()
BaseTVSync.key_1()
BaseTVSync.key_2()
BaseTVSync.key_3()
BaseTVSync.key_4()
BaseTVSync.key_5()
BaseTVSync.key_6()
BaseTVSync.key_7()
BaseTVSync.key_8()
BaseTVSync.key_9()
BaseTVSync.key_a()
BaseTVSync.key_b()
BaseTVSync.key_c()
BaseTVSync.key_d()
BaseTVSync.key_e()
BaseTVSync.key_f()
BaseTVSync.key_g()
BaseTVSync.key_h()
BaseTVSync.key_i()
BaseTVSync.key_j()
BaseTVSync.key_k()
BaseTVSync.key_l()
BaseTVSync.key_m()
BaseTVSync.key_n()
BaseTVSync.key_o()
BaseTVSync.key_p()
BaseTVSync.key_q()
BaseTVSync.key_r()
BaseTVSync.key_s()
BaseTVSync.key_t()
BaseTVSync.key_u()
BaseTVSync.key_v()
BaseTVSync.key_w()
BaseTVSync.key_x()
BaseTVSync.key_y()
BaseTVSync.key_z()
BaseTVSync.launch_app()
BaseTVSync.learn_sendevent()
BaseTVSync.left()
BaseTVSync.media_next_track()
BaseTVSync.media_pause()
BaseTVSync.media_play()
BaseTVSync.media_play_pause()
BaseTVSync.media_previous_track()
BaseTVSync.media_session_state()
BaseTVSync.media_stop()
BaseTVSync.menu()
BaseTVSync.mute_volume()
BaseTVSync.power()
BaseTVSync.right()
BaseTVSync.running_apps()
BaseTVSync.screen_on()
BaseTVSync.screen_on_awake_wake_lock_size()
BaseTVSync.set_volume_level()
BaseTVSync.sleep()
BaseTVSync.space()
BaseTVSync.start_intent()
BaseTVSync.stop_app()
BaseTVSync.stream_music_properties()
BaseTVSync.turn_off()
BaseTVSync.turn_on()
BaseTVSync.up()
BaseTVSync.volume()
BaseTVSync.volume_down()
BaseTVSync.volume_level()
BaseTVSync.volume_up()
BaseTVSync.wake_lock_size()
- androidtv.basetv.basetv module
- Module contents
- Submodules
- androidtv.firetv package
Submodules
- androidtv.constants module
CMD_AUDIO_STATE
CMD_AUDIO_STATE11
CMD_AWAKE
CMD_CURRENT_APP
CMD_CURRENT_APP11
CMD_CURRENT_APP12
CMD_CURRENT_APP13
CMD_CURRENT_APP_GOOGLE_TV
CMD_CURRENT_APP_MEDIA_SESSION_STATE
CMD_CURRENT_APP_MEDIA_SESSION_STATE11
CMD_CURRENT_APP_MEDIA_SESSION_STATE12
CMD_CURRENT_APP_MEDIA_SESSION_STATE13
CMD_CURRENT_APP_MEDIA_SESSION_STATE_GOOGLE_TV
CMD_DEFINE_CURRENT_APP_VARIABLE
CMD_DEFINE_CURRENT_APP_VARIABLE11
CMD_DEFINE_CURRENT_APP_VARIABLE12
CMD_DEFINE_CURRENT_APP_VARIABLE13
CMD_DEFINE_CURRENT_APP_VARIABLE_GOOGLE_TV
CMD_DEVICE_PROPERTIES
CMD_HDMI_INPUT
CMD_HDMI_INPUT11
CMD_INSTALLED_APPS
CMD_LAUNCH_APP
CMD_LAUNCH_APP11
CMD_LAUNCH_APP12
CMD_LAUNCH_APP13
CMD_LAUNCH_APP_CONDITION
CMD_LAUNCH_APP_CONDITION_FIRETV
CMD_LAUNCH_APP_FIRETV
CMD_LAUNCH_APP_GOOGLE_TV
CMD_MEDIA_SESSION_STATE
CMD_PARSE_CURRENT_APP
CMD_PARSE_CURRENT_APP11
CMD_RUNNING_APPS_ANDROIDTV
CMD_RUNNING_APPS_FIRETV
CMD_SCREEN_ON
CMD_SCREEN_ON_AWAKE_WAKE_LOCK_SIZE
CMD_STREAM_MUSIC
CMD_TURN_OFF_ANDROIDTV
CMD_TURN_OFF_FIRETV
CMD_TURN_ON_ANDROIDTV
CMD_TURN_ON_FIRETV
CMD_VOLUME_SET_COMMAND
CMD_VOLUME_SET_COMMAND11
CMD_WAKE_LOCK_SIZE
DEFAULT_ADB_TIMEOUT_S
DEFAULT_AUTH_TIMEOUT_S
DEFAULT_LOCK_TIMEOUT_S
DEFAULT_TRANSPORT_TIMEOUT_S
DeviceEnum
HA_CUSTOMIZABLE_COMMANDS
MEDIA_SESSION_STATES
VALID_PROPERTIES
VALID_PROPERTIES_TYPES
VALID_STATES
VALID_STATE_PROPERTIES
- androidtv.exceptions module
- androidtv.setup_async module
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.ha_state_detection_rules_validator(exc)[source]
Validate the rules (i.e., the
state_detection_rules
value) for a given app ID (i.e., a key instate_detection_rules
).See
BaseTV
for more info about thestate_detection_rules
parameter.- Parameters:
exc (Exception) – The exception that will be raised if a rule is invalid
- Returns:
wrapped_state_detection_rules_validator – A function that is the same as
state_detection_rules_validator()
, but with theexc
argument provided- Return type:
function
- androidtv.setup(host, port=5555, adbkey='', adb_server_ip='', adb_server_port=5037, state_detection_rules=None, device_class='auto', auth_timeout_s=10.0, signer=None, transport_timeout_s=1.0, log_errors=True)[source]
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; may be an IP address or a host name
port (int) – The device port to which we are connecting (default is 5555)
adbkey (str) – The path to the
adbkey
file for ADB authenticationadb_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 (str) – The type of device:
'auto'
(detect whether it is an Android TV or Fire TV device),'androidtv'
, or'firetv'`
auth_timeout_s (float) – Authentication timeout (in seconds)
signer (PythonRSASigner, None) – The signer for the ADB keys, as loaded by
androidtv.adb_manager.adb_manager_sync.ADBPythonSync.load_adbkey()
transport_timeout_s (float) – Transport timeout (in seconds)
log_errors (bool) – Whether connection errors should be logged
- Returns:
The representation of the device
- Return type: