/
sensors.py
182 lines (158 loc) · 6.55 KB
/
sensors.py
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
import json
import warnings
from flask_classful import FlaskView, route
from flask_security import current_user
from marshmallow import fields
from webargs.flaskparser import use_kwargs
from werkzeug.exceptions import abort
from flexmeasures.auth.policy import ADMIN_ROLE, ADMIN_READER_ROLE
from flexmeasures.auth.decorators import permission_required_for_context
from flexmeasures.data.schemas import (
AssetIdField,
AwareDateTimeField,
DurationField,
SensorIdField,
)
from flexmeasures.data.models.generic_assets import GenericAsset
from flexmeasures.data.models.time_series import Sensor
from flexmeasures.data.services.annotations import prepare_annotations_for_chart
from flexmeasures.ui.utils.view_utils import set_time_range_for_session
class SensorAPI(FlaskView):
"""
This view exposes sensor attributes through API endpoints under development.
These endpoints are not yet part of our official API, but support the FlexMeasures UI.
"""
route_base = "/sensor"
@route("/<id>/chart/")
@use_kwargs(
{"sensor": SensorIdField(data_key="id")},
location="path",
)
@use_kwargs(
{
"event_starts_after": AwareDateTimeField(format="iso", required=False),
"event_ends_before": AwareDateTimeField(format="iso", required=False),
"beliefs_after": AwareDateTimeField(format="iso", required=False),
"beliefs_before": AwareDateTimeField(format="iso", required=False),
"include_data": fields.Boolean(required=False),
"include_sensor_annotations": fields.Boolean(required=False),
"include_asset_annotations": fields.Boolean(required=False),
"include_account_annotations": fields.Boolean(required=False),
"dataset_name": fields.Str(required=False),
"height": fields.Str(required=False),
"width": fields.Str(required=False),
},
location="query",
)
@permission_required_for_context("read", arg_name="sensor")
def get_chart(self, id: int, sensor: Sensor, **kwargs):
"""GET from /sensor/<id>/chart
.. :quickref: Chart; Download a chart with time series
"""
set_time_range_for_session()
return json.dumps(sensor.chart(**kwargs))
@route("/<id>/chart_data/")
@use_kwargs(
{"sensor": SensorIdField(data_key="id")},
location="path",
)
@use_kwargs(
{
"event_starts_after": AwareDateTimeField(format="iso", required=False),
"event_ends_before": AwareDateTimeField(format="iso", required=False),
"beliefs_after": AwareDateTimeField(format="iso", required=False),
"beliefs_before": AwareDateTimeField(format="iso", required=False),
"resolution": DurationField(required=False),
"most_recent_beliefs_only": fields.Boolean(required=False),
},
location="query",
)
@permission_required_for_context("read", arg_name="sensor")
def get_chart_data(self, id: int, sensor: Sensor, **kwargs):
"""GET from /sensor/<id>/chart_data
.. :quickref: Chart; Download time series for use in charts
Data for use in charts (in case you have the chart specs already).
"""
return sensor.search_beliefs(as_json=True, **kwargs)
@route("/<id>/chart_annotations/")
@use_kwargs(
{"sensor": SensorIdField(data_key="id")},
location="path",
)
@use_kwargs(
{
"event_starts_after": AwareDateTimeField(format="iso", required=False),
"event_ends_before": AwareDateTimeField(format="iso", required=False),
"beliefs_after": AwareDateTimeField(format="iso", required=False),
"beliefs_before": AwareDateTimeField(format="iso", required=False),
},
location="query",
)
@permission_required_for_context("read", arg_name="sensor")
def get_chart_annotations(self, id: int, sensor: Sensor, **kwargs):
"""GET from /sensor/<id>/chart_annotations
.. :quickref: Chart; Download annotations for use in charts
Annotations for use in charts (in case you have the chart specs already).
"""
event_starts_after = kwargs.get("event_starts_after", None)
event_ends_before = kwargs.get("event_ends_before", None)
df = sensor.generic_asset.search_annotations(
annotations_after=event_starts_after,
annotations_before=event_ends_before,
as_frame=True,
)
# Wrap and stack annotations
df = prepare_annotations_for_chart(df)
# Return JSON records
df = df.reset_index()
df["source"] = df["source"].astype(str)
return df.to_json(orient="records")
@route("/<id>/")
@use_kwargs(
{"sensor": SensorIdField(data_key="id")},
location="path",
)
@permission_required_for_context("read", arg_name="sensor")
def get(self, id: int, sensor: Sensor):
"""GET from /sensor/<id>
.. :quickref: Chart; Download sensor attributes for use in charts
"""
attributes = ["name", "timezone", "timerange"]
return {attr: getattr(sensor, attr) for attr in attributes}
class AssetAPI(FlaskView):
"""
This view exposes asset attributes through API endpoints under development.
These endpoints are not yet part of our official API, but support the FlexMeasures UI.
"""
route_base = "/asset"
@route("/<id>/")
@use_kwargs(
{"asset": AssetIdField(data_key="id")},
location="path",
)
@permission_required_for_context("read", arg_name="asset")
def get(self, id: int, asset: GenericAsset):
"""GET from /asset/<id>
.. :quickref: Chart; Download asset attributes for use in charts
"""
attributes = ["name", "timezone", "timerange_of_sensors_to_show"]
return {attr: getattr(asset, attr) for attr in attributes}
def get_sensor_or_abort(id: int) -> Sensor:
"""
Util function to help the GET requests. Will be obsolete..
"""
warnings.warn(
"Util function will be deprecated. Switch to using SensorIdField to suppress this warning.",
FutureWarning,
)
sensor = Sensor.query.filter(Sensor.id == id).one_or_none()
if sensor is None:
raise abort(404, f"Sensor {id} not found")
if not (
current_user.has_role(ADMIN_ROLE)
or current_user.has_role(ADMIN_READER_ROLE)
or sensor.generic_asset.owner is None # public
or sensor.generic_asset.owner == current_user.account # private but authorized
):
raise abort(403)
return sensor