1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
"""Communicate with an Amazon Fire TV device via ADB over a network.
ADB Debugging must be enabled.
"""
import logging
from .base_firetv import BaseFireTV
from ..basetv.basetv_async import BaseTVAsync
_LOGGER = logging.getLogger(__name__)
class FireTVAsync(BaseTVAsync, BaseFireTV):
"""Representation of an Amazon Fire TV device.
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 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 :class:`~androidtv.basetv.basetv.BaseTV`)
signer : PythonRSASigner, None
The signer for the ADB keys, as loaded by :meth:`androidtv.adb_manager.adb_manager_async.ADBPythonAsync.load_adbkey`
"""
def __init__(
self,
host,
port=5555,
adbkey="",
adb_server_ip="",
adb_server_port=5037,
state_detection_rules=None,
signer=None,
): # pylint: disable=super-init-not-called
BaseTVAsync.__init__(self, host, port, adbkey, adb_server_ip, adb_server_port, state_detection_rules, signer)
@classmethod
def from_base(cls, base_tv):
"""Construct a `FireTVAsync` object from a `BaseTVAsync` object.
Parameters
----------
base_tv : BaseTVAsync
The object that will be converted to a `FireTVAsync` object
Returns
-------
ftv : FireTVAsync
The constructed `FireTVAsync` object
"""
# pylint: disable=protected-access
ftv = cls(
base_tv.host,
base_tv.port,
base_tv.adbkey,
base_tv.adb_server_ip,
base_tv.adb_server_port,
base_tv._state_detection_rules,
)
ftv._adb = base_tv._adb
ftv.device_properties = base_tv.device_properties
ftv.installed_apps = base_tv.installed_apps
ftv.max_volume = base_tv.max_volume
return ftv
# ======================================================================= #
# #
# Home Assistant Update #
# #
# ======================================================================= #
async def update(self, get_running_apps=True, lazy=True):
"""Get the info needed for a Home Assistant update.
Parameters
----------
get_running_apps : bool
Whether or not to get the :meth:`~androidtv.firetv.firetv_sync.FireTVSync.running_apps` property
lazy : bool
Whether or not to continue retrieving properties if the device is off or the screensaver is running
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]``
hdmi_input : str, None
The HDMI input, or ``None`` if it could not be determined
"""
# Get the properties needed for the update
(
screen_on,
awake,
wake_lock_size,
current_app,
media_session_state,
running_apps,
hdmi_input,
) = await self.get_properties(get_running_apps=get_running_apps, lazy=lazy)
return self._update(
screen_on, awake, wake_lock_size, current_app, media_session_state, running_apps, hdmi_input
)
# ======================================================================= #
# #
# Properties #
# #
# ======================================================================= #
async def get_properties(self, get_running_apps=True, lazy=False):
"""Get the properties needed for Home Assistant updates.
Parameters
----------
get_running_apps : bool
Whether or not to get the :meth:`~androidtv.firetv.firetv_async.FireTVAsync.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
hdmi_input : str, None
The HDMI input, or ``None`` if it could not be determined
"""
screen_on, awake, wake_lock_size = await self.screen_on_awake_wake_lock_size()
if lazy and not (screen_on and awake):
return screen_on, awake, wake_lock_size, None, None, None, None
current_app, media_session_state = await self.current_app_media_session_state()
if get_running_apps:
running_apps = await self.running_apps()
else:
running_apps = None
hdmi_input = await self.get_hdmi_input()
return screen_on, awake, wake_lock_size, current_app, media_session_state, running_apps, hdmi_input
async def get_properties_dict(self, 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 :meth:`~androidtv.firetv.firetv_async.FireTVAsync.running_apps` property
lazy : bool
Whether or not to continue retrieving properties if the device is off or the screensaver is running
Returns
-------
dict
A dictionary with keys ``'screen_on'``, ``'awake'``, ``'wake_lock_size'``, ``'current_app'``,
``'media_session_state'``, ``'running_apps'``, and ``'hdmi_input'``
"""
(
screen_on,
awake,
wake_lock_size,
current_app,
media_session_state,
running_apps,
hdmi_input,
) = await self.get_properties(get_running_apps=get_running_apps, lazy=lazy)
return {
"screen_on": screen_on,
"awake": awake,
"wake_lock_size": wake_lock_size,
"current_app": current_app,
"media_session_state": media_session_state,
"running_apps": running_apps,
"hdmi_input": hdmi_input,
}
|
