make web/README a bit more verbose

[chrisu/seepark.git] / web / seepark_web.py

diff --git a/web/seepark_web.py b/web/seepark_web.py
index 4814d0fb22493f6381dfdbd79918aa31aaf3f66d..523e52deead8d31914190d8c9ad234ece18eb8ca 100644 (file)
--- a/web/seepark_web.py
+++ b/web/seepark_web.py
@@ -1,11 +1,10 @@
-from random import uniform

 import datetime
 import time
 import configparser
 import os
 import sys
 from collections import defaultdict
 import datetime
 import time
 import configparser
 import os
 import sys
 from collections import defaultdict

-from flask import Flask, render_template, jsonify, request
+from flask import Flask, render_template, jsonify, request, abort, Response

 import flask.json
 from flask_sqlalchemy import SQLAlchemy, inspect
 
 import flask.json
 from flask_sqlalchemy import SQLAlchemy, inspect
 


@@ -75,7 +74,7 @@ def select_sensordata(sensor_id, sensor_type, begin, end, mode):
         query = query.filter(Sensors.timestamp >= begin)
     if end is not None:
         query = query.filter(Sensors.timestamp <= end)
         query = query.filter(Sensors.timestamp >= begin)
     if end is not None:
         query = query.filter(Sensors.timestamp <= end)

-    if mode == 'consolidated' and begin is None and end is None:
+    if mode == 'consolidated' and begin is not None and end is not None:

         # copied from munin/master/_bin/munin-cgi-graph.in
         # interval in seconds for data points
         resolutions = dict(
         # copied from munin/master/_bin/munin-cgi-graph.in
         # interval in seconds for data points
         resolutions = dict(


@@ -86,11 +85,11 @@ def select_sensordata(sensor_id, sensor_type, begin, end, mode):
         )
         duration = (end - begin).total_seconds()
         day = 60 * 60 * 24
         )
         duration = (end - begin).total_seconds()
         day = 60 * 60 * 24

-        if duration < day:
+        if duration <= day:

             resolution = resolutions['day']
             resolution = resolutions['day']

-        elif duration < 7 * day:
+        elif duration <= 7 * day:

             resolution = resolutions['week']
             resolution = resolutions['week']

-        elif duration < 31 * day:
+        elif duration <= 31 * day:

             resolution = resolutions['month']
         else:
             resolution = resolutions['year']
             resolution = resolutions['month']
         else:
             resolution = resolutions['year']


@@ -106,7 +105,7 @@ def select_openweatherdata(cityid, begin, end, mode):
         query = query.filter(OpenWeatherMap.datetime >= begin)
     if end is not None:
         query = query.filter(OpenWeatherMap.datetime <= end)
         query = query.filter(OpenWeatherMap.datetime >= begin)
     if end is not None:
         query = query.filter(OpenWeatherMap.datetime <= end)

-    if mode == 'consolidated' and begin is None and end is None:
+    if mode == 'consolidated' and begin is not None and end is not None:

         # copied from munin/master/_bin/munin-cgi-graph.in
         # interval in seconds for data points
         resolutions = dict(
         # copied from munin/master/_bin/munin-cgi-graph.in
         # interval in seconds for data points
         resolutions = dict(


@@ -131,48 +130,58 @@ def select_openweatherdata(cityid, begin, end, mode):
     return query.all()
 
 
     return query.all()
 
 

-def convert_to_c3(result):
+def convert_to_c3(result, id, field_x, field_y):

     c3result = defaultdict(list)
     for row in result:
     c3result = defaultdict(list)
     for row in result:

-        c3result[row.sensor_id].append(row.value)
-        dt = row.timestamp.strftime('%Y-%m-%d %H:%M:%S')
-        c3result[row.sensor_id + '_x'].append(dt)
+        c3result[getattr(row, id)].append(getattr(row, field_y))
+        dt = getattr(row, field_x).strftime('%Y-%m-%d %H:%M:%S')
+        c3result[str(getattr(row, id)) + '_x'].append(dt)

     return c3result
 
 
     return c3result
 
 

+def request_arg(key, type, default=None):
+    """Returns the key from the request if available, otherwise the default value.
+    In case type is provided and the key is present, the value is converted by calling type.
+    In other words: Reimplement request.args.get but don't return default value if
+    type raises a ValueError."""
+    if key in request.args:
+        try:
+            return type(request.args[key])
+        except ValueError as e:
+            abort(Response(str(e), 400))
+    else:
+        return default
+
+

 def sensordata(sensor_id=None, sensor_type=None):
 def sensordata(sensor_id=None, sensor_type=None):

-    begin = request.args.get('begin', None, parse_datetime)
-    end = request.args.get('end', None, parse_datetime)
+    begin = request_arg('begin', parse_datetime)
+    end = request_arg('end', parse_datetime)

     mode = request.args.get('mode', 'full')
     format = request.args.get('format', 'default')
 
     result = select_sensordata(sensor_id, sensor_type, begin, end, mode)
 
     if format == 'c3':
     mode = request.args.get('mode', 'full')
     format = request.args.get('format', 'default')
 
     result = select_sensordata(sensor_id, sensor_type, begin, end, mode)
 
     if format == 'c3':

-        return convert_to_c3(result)
+        return convert_to_c3(result, 'sensor_id', 'timestamp', 'value')

     return result
 
 
 def openweathermapdata(cityid):
     return result
 
 
 def openweathermapdata(cityid):

-    begin = request.args.get('begin', None, parse_datetime)
-    end = request.args.get('end', None, parse_datetime)
+    begin = request_arg('begin', parse_datetime)
+    end = request_arg('end', parse_datetime)

     mode = request.args.get('mode', 'full')
     format = request.args.get('format', 'default')
 
     result = select_openweatherdata(cityid, begin, end, mode)
 
     if format == 'c3':
     mode = request.args.get('mode', 'full')
     format = request.args.get('format', 'default')
 
     result = select_openweatherdata(cityid, begin, end, mode)
 
     if format == 'c3':

-        return convert_to_c3(result)
+        return convert_to_c3(result, 'cityid', 'datetime', 'temp')

     return result
 
 
     return result
 
 

-def currentairtemperature(apikey, cityid):
-    """Retruns the tuple temperature, datetime (as float, datetime) in case of success, otherwise None, None."""
-    try:
-        url, weatherdata = openweathermap_json(apikey, cityid)
-        return weatherdata['main']['temp'], datetime.datetime.fromtimestamp(weatherdata['dt'])
-    except OpenWeatherMapError:
-        return None, None
+def currentairtemperature(cityid):
+    result = OpenWeatherMap.query.filter_by(cityid=cityid).order_by(OpenWeatherMap.datetime.desc()).first()
+    return result.temp, result.datetime

 
 
 def currentwatertemperature(sensorid):
 
 
 def currentwatertemperature(sensorid):


@@ -229,39 +238,9 @@ def openweathermap_city(version, cityid):
     return jsonify(result)
 
 
     return jsonify(result)
 
 

-@app.route('/data/', defaults={'timespan': 1})
-@app.route("/data/<int:timespan>", methods=['GET'])
-def data(timespan):
-    granularity = 5 * timespan               # (every) minute(s) per day
-    samples = 60/granularity * 24 * timespan # per hour over whole timespan
-    s4m   = []
-    s4m_x = []
-    s5m   = []
-    s5m_x = []
-    end   = time.time()
-    start = end - samples * granularity * 60
-
-    for i in range(int(samples)):
-        s4m.append(uniform(-10,30))
-        s5m.append(uniform(-10,30))
-        s4mt = uniform(start, end)
-        s5mt = uniform(start, end)
-        s4m_x.append(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(s4mt)))
-        s5m_x.append(time.strftime('%Y-%m-%d %H:%M:%S', time.localtime(s5mt)))
-
-    data = {
-        '0316a2193bff':   s4m,
-        '0316a2193bff_x': s4m_x,
-        '0316a21383ff':   s5m,
-        '0316a21383ff_x': s5m_x,
-        }
-
-    return jsonify(data)
-
-

 @app.route("/")
 def index():
 @app.route("/")
 def index():

-    airvalue, airtime     = currentairtemperature(apikey, cityid)
+    airvalue, airtime     = currentairtemperature(cityid)

     watervalue, watertime = currentwatertemperature(mainsensor)
 
     return render_template(
     watervalue, watertime = currentwatertemperature(mainsensor)
 
     return render_template(