Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.androidtv Namespace Reference

Namespaces

 config_flow
 
 const
 
 diagnostics
 
 entity
 
 media_player
 
 remote
 

Classes

class  AndroidTVRuntimeData
 

Functions

tuple[str, PythonRSASigner|None, str] _setup_androidtv (HomeAssistant hass, Mapping[str, Any] config)
 
tuple[AndroidTVAsync|FireTVAsync|None, str|None] async_connect_androidtv (HomeAssistant hass, Mapping[str, Any] config, *dict[str, Any]|None state_detection_rules=None, float timeout=30.0)
 
bool async_migrate_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_setup_entry (HomeAssistant hass, AndroidTVConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, AndroidTVConfigEntry entry)
 
str|None get_androidtv_mac (dict[str, Any] dev_props)
 
None update_listener (HomeAssistant hass, AndroidTVConfigEntry entry)
 

Variables

dictionary _INVALID_MACS = {"ff:ff:ff:ff:ff:ff"}
 
 _LOGGER = logging.getLogger(__name__)
 
 AndroidTVConfigEntry = ConfigEntry[AndroidTVRuntimeData]
 
list PLATFORMS = [Platform.MEDIA_PLAYER, Platform.REMOTE]
 
list RELOAD_OPTIONS = [CONF_STATE_DETECTION_RULES]
 
 tuple
 

Detailed Description

Support for functionality to interact with Android/Fire TV devices.

Function Documentation

◆ _setup_androidtv()

tuple[str, PythonRSASigner | None, str] homeassistant.components.androidtv._setup_androidtv ( HomeAssistant  hass,
Mapping[str, Any]   config 
)
private
Generate an ADB key (if needed) and load it.

Definition at line 95 of file __init__.py.

◆ async_connect_androidtv()

tuple[AndroidTVAsync | FireTVAsync | None, str | None] homeassistant.components.androidtv.async_connect_androidtv ( HomeAssistant  hass,
Mapping[str, Any]  config,
*dict[str, Any] | None   state_detection_rules = None,
float   timeout = 30.0 
)
Connect to Android device.

Definition at line 123 of file __init__.py.

◆ async_migrate_entry()

bool homeassistant.components.androidtv.async_migrate_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Migrate old entry.

Definition at line 164 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.androidtv.async_setup_entry ( HomeAssistant  hass,
AndroidTVConfigEntry  entry 
)
Set up Android Debug Bridge platform.

Definition at line 190 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.androidtv.async_unload_entry ( HomeAssistant  hass,
AndroidTVConfigEntry  entry 
)
Unload a config entry.

Definition at line 225 of file __init__.py.

◆ get_androidtv_mac()

str | None homeassistant.components.androidtv.get_androidtv_mac ( dict[str, Any]  dev_props)
Return formatted mac from device properties.

Definition at line 85 of file __init__.py.

◆ update_listener()

None homeassistant.components.androidtv.update_listener ( HomeAssistant  hass,
AndroidTVConfigEntry  entry 
)
Update when config_entry options update.

Definition at line 234 of file __init__.py.

Variable Documentation

◆ _INVALID_MACS

dictionary homeassistant.components.androidtv._INVALID_MACS = {"ff:ff:ff:ff:ff:ff"}
private

Definition at line 69 of file __init__.py.

◆ _LOGGER

homeassistant.components.androidtv._LOGGER = logging.getLogger(__name__)
private

Definition at line 71 of file __init__.py.

◆ AndroidTVConfigEntry

homeassistant.components.androidtv.AndroidTVConfigEntry = ConfigEntry[AndroidTVRuntimeData]

Definition at line 82 of file __init__.py.

◆ PLATFORMS

list homeassistant.components.androidtv.PLATFORMS = [Platform.MEDIA_PLAYER, Platform.REMOTE]

Definition at line 66 of file __init__.py.

◆ RELOAD_OPTIONS

list homeassistant.components.androidtv.RELOAD_OPTIONS = [CONF_STATE_DETECTION_RULES]

Definition at line 67 of file __init__.py.

◆ tuple

homeassistant.components.androidtv.tuple

Definition at line 54 of file __init__.py.