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
|
from math import trunc
from datetime import timezone
import asyncio
import aiohttp
import async_timeout
BASE_URL = "https://api.foobot.io/v2/"
DEVICE_URL = BASE_URL + 'owner/{username}/device/'
LAST_DATA_URL = BASE_URL + \
"device/{uuid}/datapoint/{period:d}/last/{average_by:d}/"
HISTORICAL_DATA_URL = BASE_URL + \
"device/{uuid}/datapoint/{start:d}/{end:d}/{average_by:d}/"
class FoobotClient():
"""
Foobot API client
:param token: API secret key used for authentication, see main doc on how
to obtain one
:type token: str
:param username: Your username for your Foobot account
:type username: str
:param session: aiohttp session to use or None
:type session: object or None
:param timeout: seconds to wait for before triggering a timeout
:type timeout: integer
"""
def __init__(self, token, username, session=None,
timeout=aiohttp.client.DEFAULT_TIMEOUT.total):
"""
Creates a new :class:`FoobotClient` instance.
"""
self._headers = {'X-API-KEY-TOKEN': token,
'content-type': 'application/json'}
self._username = username
self._timeout = timeout
if session is not None:
self._session = session
async def get_devices(self):
"""
Get a list of devices associated with that account.
:returns: list of devices
:raises: ClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. note::
each device returned will be a dictionary with the following data:
* uuid: id of the device, used for querying data from them.
Not actually a UUID.
* userId: id of the user
* mac: MAC of the device, non colon seperated
(eg: "013843C3C20A")
* name: Name of the device as configured in the app
"""
return (await self._get(DEVICE_URL.format(
username=self._username)))
async def get_last_data(self, uuid, period=0, average_by=0):
"""
Get the data from one device for period till now.
:param uuid: Id of the device
:type uuid: str
:param period: Number of seconds between start time of search and now
:type period: integer
:param average_by: amount of seconds to average data over.
0 or 300 for no average. Use 3600 (average hourly) or a multiple
for long range requests (e.g. more than 1 day)
:type average_by: integer
:returns: list of datapoints
:raises: ClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. note::
Use period = 0 and averageBy = 0 to get the very last data point.
If you only need one average for a period, the average_by needs to
be bigger than the period (eg, for a 10 minutes average:
period = 600, average_by = 601)
.. seealso:: :func:`parse_data` for return data syntax
"""
return self.parse_data((await self._get(
LAST_DATA_URL.format(uuid=uuid,
period=trunc(period),
average_by=trunc(average_by)))))
async def get_historical_data(self, uuid, start, end, average_by=0):
"""
Get the data from one device for a specified time range.
.. note::
Can fetch a maximum of 42 days of data.
To speed up query processing, you can use a combination of average
factor multiple of 1H in seconds (e.g. 3600)
and o'clock start and end times
:param uuid: Id of the device
:type uuid: str
:param start: start of the range
:type start: datetime
:param end: end of the range
:type end: datetime
:param average_by: amount of seconds to average data over.
0 or 300 for no average. Use 3600 (average hourly) or a multiple
for long range requests (e.g. more than 1 day)
:type average_by: integer
:returns: list of datapoints
:raises: ClientError, AuthFailure, BadFormat, ForbiddenAccess,
TooManyRequests, InternalError
.. seealso:: :func:`parse_data` for return data syntax
"""
return self.parse_data((await self._get(
HISTORICAL_DATA_URL.format(
uuid=uuid,
start=trunc(start.replace(tzinfo=timezone.utc).timestamp()),
end=trunc(end.replace(tzinfo=timezone.utc).timestamp()),
average_by=trunc(average_by)))))
def parse_data(self, response):
"""
Convert the weird list format used for datapoints to a more usable
dictionnary one
:param response: dictionnary from API json response
:type response: dict
:returns: list of datapoints
.. note::
Datapoint content:
* time: UTC timestamp, unit: seconds
* pm: Particulate Matter, unit: ugm3
* tmp: temperature, unit: C
* hum: humidity, unit: %
* co2: Carbon Dioxide, unit: ppm
* voc: Volatile Organic Compounds, unit: ppb
* allpollu: `foobot index <https://help.foobot.io/hc/en-us/articles/204814371-What-does-central-number-mean->`_, unit: %
"""
parsed = []
try:
items = response['sensors']
for datapoint in response['datapoints']:
line = {}
for index, data in enumerate(datapoint):
line[items[index]] = data
parsed.append(line)
return parsed
except (KeyError, IndexError, TypeError):
raise FoobotClient.InvalidData()
async def _get(self, path, **kwargs):
if not hasattr(self, '_session'):
self._session = aiohttp.ClientSession()
async with async_timeout.timeout(self._timeout):
resp = await self._session.get(
path, headers=dict(self._headers, **kwargs))
resp_text = await resp.text()
if resp.status == 400:
raise FoobotClient.BadFormat(resp_text)
elif resp.status == 401:
raise FoobotClient.AuthFailure(resp_text)
elif resp.status == 403:
raise FoobotClient.ForbiddenAccess(resp_text)
elif resp.status == 429:
raise FoobotClient.TooManyRequests(resp_text)
elif resp.status == 500:
raise FoobotClient.InternalError(resp_text)
elif resp.status != 200:
raise FoobotClient.ClientError(resp_text)
return (await resp.json())
class ClientError(Exception):
"""Generic Error."""
pass
class AuthFailure(ClientError):
"""Failed Authentication."""
pass
class BadFormat(ClientError):
"""Request is malformed."""
pass
class ForbiddenAccess(ClientError):
"""Access is prohibited."""
pass
class TooManyRequests(ClientError):
"""Too many requests for this time period."""
pass
class InternalError(ClientError):
"""Server Internal Error."""
pass
class InvalidData(ClientError):
"""Can't parse response data."""
pass
|
