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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
"""Python wrapper for the official Logi Circle API"""
# coding: utf-8
# vim:sw=4:ts=4:et:
import logging
import subprocess
from .const import (DEFAULT_SCOPES,
DEFAULT_CACHE_FILE,
API_BASE,
ACCOUNT_ENDPOINT,
ACCESSORIES_ENDPOINT,
NOTIFICATIONS_ENDPOINT,
DEFAULT_FFMPEG_BIN)
from .auth import AuthProvider
from .camera import Camera
from .subscription import Subscription
from .exception import NotAuthorized, AuthorizationFailed, SessionInvalidated
from .utils import _get_ids_for_cameras
_LOGGER = logging.getLogger(__name__)
class LogiCircle():
"""A Python abstraction object to Logi Circle cameras."""
def __init__(self,
client_id,
client_secret,
redirect_uri,
api_key,
scopes=DEFAULT_SCOPES,
ffmpeg_path=None,
cache_file=DEFAULT_CACHE_FILE,
update_throttle=30):
self.auth_provider = AuthProvider(client_id=client_id,
client_secret=client_secret,
redirect_uri=redirect_uri,
scopes=scopes,
cache_file=cache_file,
logi_base=self)
self.authorize = self.auth_provider.authorize
self.api_key = api_key
self.ffmpeg_path = self._get_ffmpeg_path(ffmpeg_path)
self.is_connected = False
self.update_throttle = update_throttle
self._subscriptions = []
self._cameras = []
@property
def authorized(self):
"""Checks if the current client ID has a refresh token"""
return self.auth_provider.authorized
@property
def authorize_url(self):
"""Returns the authorization URL for the Logi Circle API"""
return self.auth_provider.authorize_url
async def close(self):
"""Closes the aiohttp session"""
await self.auth_provider.close()
@property
async def account(self):
"""Get account data from accounts endpoint."""
return await self._fetch(ACCOUNT_ENDPOINT)
def flush_cameras(self):
"""Destroys cached camera list."""
self._cameras = None
async def synchronize_cameras(self):
"""Caches camera list."""
await self.cameras
@property
async def cameras(self):
"""Return all cameras."""
if self._cameras:
# Returned cached list
return self._cameras
# Get cameras from remote API
cameras = []
raw_cameras = await self._fetch(ACCESSORIES_ENDPOINT)
for camera in raw_cameras:
cameras.append(Camera(self, camera))
self._cameras = cameras
return cameras
async def subscribe(self, event_types, cameras=None, ping_interval=60):
"""Subscribe camera(s) to one or more event types"""
if not cameras:
# If no cameras specified, subscribe all
cameras = await self.cameras
request = {"accessories": _get_ids_for_cameras(cameras),
"eventTypes": event_types}
# Request WS URL
wss_url_request = await self._fetch(url=NOTIFICATIONS_ENDPOINT,
headers={"X-Logi-NoRedirect": "true"},
request_body=request,
method='POST',
raw=True)
# Retrieve WS URL from header and return Subscription object
wss_url = wss_url_request.headers['X-Logi-Websocket-Url']
wss_url_request.close()
subscription = Subscription(wss_url=wss_url,
cameras=cameras,
ping_interval=ping_interval)
self._subscriptions.append(subscription)
return subscription
@property
def subscriptions(self):
"""Returns all WS subscriptions."""
return self._subscriptions
def _check_readiness(self):
"""Checks that this library is ready to submit requests to the Logi Circle API"""
if not self.auth_provider.authorized:
raise NotAuthorized('No access token available for this client ID')
if self.auth_provider.invalid:
raise SessionInvalidated('Logi API session invalidated due to 4xx exception refreshing token')
async def _fetch(self,
url,
method='GET',
params=None,
request_body=None,
headers=None,
relative_to_api_root=True,
raw=False,
_reattempt=False):
"""Query data from the Logi Circle API."""
# pylint: disable=too-many-locals
self._check_readiness()
base_headers = {
'X-API-Key': self.api_key,
'Authorization': 'Bearer %s' % (self.auth_provider.access_token)
}
request_headers = {**base_headers, **(headers or {})}
resolved_url = (API_BASE + url if relative_to_api_root else url)
_LOGGER.debug("Fetching %s (%s)", resolved_url, method)
resp = None
session = await self.auth_provider.get_session()
# Perform request
if method == 'GET':
resp = await session.get(resolved_url,
headers=request_headers,
params=params,
allow_redirects=False)
elif method in ['POST', 'PUT', 'DELETE']:
func = getattr(session, method.lower())
resp = await func(resolved_url,
headers=request_headers,
params=params,
json=request_body,
allow_redirects=False)
else:
raise ValueError('Method %s not supported.' % (method))
content_type = resp.headers.get('content-type')
_LOGGER.debug('Request %s (%s) returned %s with content type %s',
resolved_url, method, resp.status, content_type)
if resp.headers.get('X-Logi-Error'):
_LOGGER.debug('Error header included with message: %s', resp.headers['X-Logi-Error'])
if resp.status == 301 or resp.status == 302:
# We need to implement our own redirect handling - Logi API
# requires auth headers to passed to the redirected resource, but
# aiohttp doesn't do this.
redirect_uri = resp.headers['location']
return await self._fetch(
url=redirect_uri,
method=method,
params=params,
request_body=request_body,
headers=headers,
relative_to_api_root=False,
raw=raw
)
if resp.status == 401 and not _reattempt:
# Token may have expired. Refresh and try again.
await self.auth_provider.refresh()
return await self._fetch(
url=url,
method=method,
params=params,
request_body=request_body,
relative_to_api_root=relative_to_api_root,
raw=raw,
_reattempt=True
)
if resp.status == 401 and _reattempt:
raise AuthorizationFailed('Could not refresh access token')
resp.raise_for_status()
if raw:
# Return unread ClientResponse object to client.
return resp
if 'json' in content_type:
resp_data = await resp.json()
else:
resp_data = await resp.read()
resp.close()
return resp_data
@staticmethod
def _get_ffmpeg_path(ffmpeg_path=None):
"""Returns a bool indicating whether ffmpeg is installed."""
resolved_ffmpeg_path = ffmpeg_path or DEFAULT_FFMPEG_BIN
try:
subprocess.check_call([resolved_ffmpeg_path, "-version"],
stdout=subprocess.DEVNULL)
return resolved_ffmpeg_path
except OSError:
_LOGGER.warning(
'ffmpeg is not installed! Not all API methods will function.')
return None
|
