296 lines
15 KiB
Python
296 lines
15 KiB
Python
import re
|
|
import falcon
|
|
import simplejson as json
|
|
import mysql.connector
|
|
import config
|
|
from datetime import datetime, timedelta, timezone
|
|
from core import utilities
|
|
import excelexporters.metertrend
|
|
|
|
|
|
class Reporting:
|
|
@staticmethod
|
|
def __init__():
|
|
""""Initializes Reporting"""
|
|
pass
|
|
|
|
@staticmethod
|
|
def on_options(req, resp):
|
|
resp.status = falcon.HTTP_200
|
|
|
|
####################################################################################################################
|
|
# PROCEDURES
|
|
# Step 1: valid parameters
|
|
# Step 2: query the meter and energy category
|
|
# Step 3: query associated points
|
|
# Step 4: query reporting period points trends
|
|
# Step 5: query tariff data
|
|
# Step 6: construct the report
|
|
####################################################################################################################
|
|
@staticmethod
|
|
def on_get(req, resp):
|
|
print(req.params)
|
|
meter_id = req.params.get('meterid')
|
|
meter_uuid = req.params.get('meteruuid')
|
|
reporting_period_start_datetime_local = req.params.get('reportingperiodstartdatetime')
|
|
reporting_period_end_datetime_local = req.params.get('reportingperiodenddatetime')
|
|
quick_mode = req.params.get('quickmode')
|
|
|
|
################################################################################################################
|
|
# Step 1: valid parameters
|
|
################################################################################################################
|
|
if meter_id is None and meter_uuid is None:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')
|
|
|
|
if meter_id is not None:
|
|
meter_id = str.strip(meter_id)
|
|
if not meter_id.isdigit() or int(meter_id) <= 0:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_ID')
|
|
|
|
if meter_uuid is not None:
|
|
regex = re.compile('^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}\Z', re.I)
|
|
match = regex.match(str.strip(meter_uuid))
|
|
if not bool(match):
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST', description='API.INVALID_METER_UUID')
|
|
|
|
timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
|
|
if config.utc_offset[0] == '-':
|
|
timezone_offset = -timezone_offset
|
|
|
|
if reporting_period_start_datetime_local is None:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
|
|
description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
|
|
else:
|
|
reporting_period_start_datetime_local = str.strip(reporting_period_start_datetime_local)
|
|
try:
|
|
reporting_start_datetime_utc = datetime.strptime(reporting_period_start_datetime_local,
|
|
'%Y-%m-%dT%H:%M:%S')
|
|
except ValueError:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
|
|
description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
|
|
reporting_start_datetime_utc = reporting_start_datetime_utc.replace(tzinfo=timezone.utc) - \
|
|
timedelta(minutes=timezone_offset)
|
|
|
|
if reporting_period_end_datetime_local is None:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
|
|
description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
|
|
else:
|
|
reporting_period_end_datetime_local = str.strip(reporting_period_end_datetime_local)
|
|
try:
|
|
reporting_end_datetime_utc = datetime.strptime(reporting_period_end_datetime_local,
|
|
'%Y-%m-%dT%H:%M:%S')
|
|
except ValueError:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
|
|
description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
|
|
reporting_end_datetime_utc = reporting_end_datetime_utc.replace(tzinfo=timezone.utc) - \
|
|
timedelta(minutes=timezone_offset)
|
|
|
|
if reporting_start_datetime_utc >= reporting_end_datetime_utc:
|
|
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
|
|
description='API.INVALID_REPORTING_PERIOD_END_DATETIME')
|
|
|
|
# if turn quick mode on, do not return parameters data and excel file
|
|
is_quick_mode = False
|
|
if quick_mode is not None and \
|
|
len(str.strip(quick_mode)) > 0 and \
|
|
str.lower(str.strip(quick_mode)) in ('true', 't', 'on', 'yes', 'y'):
|
|
is_quick_mode = True
|
|
|
|
################################################################################################################
|
|
# Step 2: query the meter and energy category
|
|
################################################################################################################
|
|
cnx_system = mysql.connector.connect(**config.myems_system_db)
|
|
cursor_system = cnx_system.cursor()
|
|
|
|
cnx_historical = mysql.connector.connect(**config.myems_historical_db)
|
|
cursor_historical = cnx_historical.cursor()
|
|
if meter_id is not None:
|
|
cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
|
|
" ec.name, ec.unit_of_measure, ec.kgce, ec.kgco2e "
|
|
" FROM tbl_meters m, tbl_energy_categories ec "
|
|
" WHERE m.id = %s AND m.energy_category_id = ec.id ", (meter_id,))
|
|
row_meter = cursor_system.fetchone()
|
|
elif meter_uuid is not None:
|
|
cursor_system.execute(" SELECT m.id, m.name, m.cost_center_id, m.energy_category_id, "
|
|
" ec.name, ec.unit_of_measure, ec.kgce, ec.kgco2e "
|
|
" FROM tbl_meters m, tbl_energy_categories ec "
|
|
" WHERE m.uuid = %s AND m.energy_category_id = ec.id ", (meter_uuid,))
|
|
row_meter = cursor_system.fetchone()
|
|
|
|
if row_meter is None:
|
|
if cursor_system:
|
|
cursor_system.close()
|
|
if cnx_system:
|
|
cnx_system.disconnect()
|
|
|
|
if cursor_historical:
|
|
cursor_historical.close()
|
|
if cnx_historical:
|
|
cnx_historical.disconnect()
|
|
raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND', description='API.METER_NOT_FOUND')
|
|
meter = dict()
|
|
meter['id'] = row_meter[0]
|
|
meter['name'] = row_meter[1]
|
|
meter['cost_center_id'] = row_meter[2]
|
|
meter['energy_category_id'] = row_meter[3]
|
|
meter['energy_category_name'] = row_meter[4]
|
|
meter['unit_of_measure'] = row_meter[5]
|
|
meter['kgce'] = row_meter[6]
|
|
meter['kgco2e'] = row_meter[7]
|
|
|
|
################################################################################################################
|
|
# Step 3: query associated points
|
|
################################################################################################################
|
|
point_list = list()
|
|
cursor_system.execute(" SELECT p.id, p.name, p.units, p.object_type "
|
|
" FROM tbl_meters m, tbl_meters_points mp, tbl_points p "
|
|
" WHERE m.id = %s AND m.id = mp.meter_id AND mp.point_id = p.id "
|
|
" ORDER BY p.id ", (meter['id'],))
|
|
rows_points = cursor_system.fetchall()
|
|
if rows_points is not None and len(rows_points) > 0:
|
|
for row in rows_points:
|
|
point_list.append({"id": row[0], "name": row[1], "units": row[2], "object_type": row[3]})
|
|
|
|
################################################################################################################
|
|
# Step 4: query reporting period points trends
|
|
################################################################################################################
|
|
reporting = dict()
|
|
reporting['names'] = list()
|
|
reporting['timestamps'] = list()
|
|
reporting['values'] = list()
|
|
|
|
for point in point_list:
|
|
if is_quick_mode and point['object_type'] != 'ENERGY_VALUE':
|
|
continue
|
|
|
|
point_values = []
|
|
point_timestamps = []
|
|
if point['object_type'] == 'ANALOG_VALUE':
|
|
query = (" SELECT utc_date_time, actual_value "
|
|
" FROM tbl_analog_value "
|
|
" WHERE point_id = %s "
|
|
" AND utc_date_time BETWEEN %s AND %s "
|
|
" ORDER BY utc_date_time ")
|
|
cursor_historical.execute(query, (point['id'],
|
|
reporting_start_datetime_utc,
|
|
reporting_end_datetime_utc))
|
|
rows = cursor_historical.fetchall()
|
|
|
|
if rows is not None and len(rows) > 0:
|
|
for row in rows:
|
|
current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
|
|
timedelta(minutes=timezone_offset)
|
|
current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
|
|
point_timestamps.append(current_datetime)
|
|
point_values.append(row[1])
|
|
|
|
elif point['object_type'] == 'ENERGY_VALUE':
|
|
query = (" SELECT utc_date_time, actual_value "
|
|
" FROM tbl_energy_value "
|
|
" WHERE point_id = %s "
|
|
" AND utc_date_time BETWEEN %s AND %s "
|
|
" ORDER BY utc_date_time ")
|
|
cursor_historical.execute(query, (point['id'],
|
|
reporting_start_datetime_utc,
|
|
reporting_end_datetime_utc))
|
|
rows = cursor_historical.fetchall()
|
|
|
|
if rows is not None and len(rows) > 0:
|
|
for row in rows:
|
|
current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
|
|
timedelta(minutes=timezone_offset)
|
|
current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
|
|
point_timestamps.append(current_datetime)
|
|
point_values.append(row[1])
|
|
elif point['object_type'] == 'DIGITAL_VALUE':
|
|
query = (" SELECT utc_date_time, actual_value "
|
|
" FROM tbl_digital_value "
|
|
" WHERE point_id = %s "
|
|
" AND utc_date_time BETWEEN %s AND %s "
|
|
" ORDER BY utc_date_time ")
|
|
cursor_historical.execute(query, (point['id'],
|
|
reporting_start_datetime_utc,
|
|
reporting_end_datetime_utc))
|
|
rows = cursor_historical.fetchall()
|
|
|
|
if rows is not None and len(rows) > 0:
|
|
for row in rows:
|
|
current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
|
|
timedelta(minutes=timezone_offset)
|
|
current_datetime = current_datetime_local.strftime('%Y-%m-%dT%H:%M:%S')
|
|
point_timestamps.append(current_datetime)
|
|
point_values.append(row[1])
|
|
|
|
reporting['names'].append(point['name'] + ' (' + point['units'] + ')')
|
|
reporting['timestamps'].append(point_timestamps)
|
|
reporting['values'].append(point_values)
|
|
|
|
################################################################################################################
|
|
# Step 5: query tariff data
|
|
################################################################################################################
|
|
parameters_data = dict()
|
|
parameters_data['names'] = list()
|
|
parameters_data['timestamps'] = list()
|
|
parameters_data['values'] = list()
|
|
if not is_quick_mode:
|
|
tariff_dict = utilities.get_energy_category_tariffs(meter['cost_center_id'],
|
|
meter['energy_category_id'],
|
|
reporting_start_datetime_utc,
|
|
reporting_end_datetime_utc)
|
|
print(tariff_dict)
|
|
tariff_timestamp_list = list()
|
|
tariff_value_list = list()
|
|
for k, v in tariff_dict.items():
|
|
# convert k from utc to local
|
|
k = k + timedelta(minutes=timezone_offset)
|
|
tariff_timestamp_list.append(k.isoformat()[0:19])
|
|
tariff_value_list.append(v)
|
|
|
|
parameters_data['names'].append('TARIFF-' + meter['energy_category_name'])
|
|
parameters_data['timestamps'].append(tariff_timestamp_list)
|
|
parameters_data['values'].append(tariff_value_list)
|
|
|
|
################################################################################################################
|
|
# Step 6: construct the report
|
|
################################################################################################################
|
|
if cursor_system:
|
|
cursor_system.close()
|
|
if cnx_system:
|
|
cnx_system.disconnect()
|
|
|
|
if cursor_historical:
|
|
cursor_historical.close()
|
|
if cnx_historical:
|
|
cnx_historical.disconnect()
|
|
|
|
result = {
|
|
"meter": {
|
|
"cost_center_id": meter['cost_center_id'],
|
|
"energy_category_id": meter['energy_category_id'],
|
|
"energy_category_name": meter['energy_category_name'],
|
|
"unit_of_measure": meter['unit_of_measure'],
|
|
"kgce": meter['kgce'],
|
|
"kgco2e": meter['kgco2e'],
|
|
},
|
|
"reporting_period": {
|
|
"names": reporting['names'],
|
|
"timestamps": reporting['timestamps'],
|
|
"values": reporting['values'],
|
|
},
|
|
"parameters": {
|
|
"names": parameters_data['names'],
|
|
"timestamps": parameters_data['timestamps'],
|
|
"values": parameters_data['values']
|
|
},
|
|
"excel_bytes_base64": None
|
|
}
|
|
# export result to Excel file and then encode the file to base64 string
|
|
if not is_quick_mode:
|
|
result['excel_bytes_base64'] = excelexporters.metertrend.export(result,
|
|
meter['name'],
|
|
reporting_period_start_datetime_local,
|
|
reporting_period_end_datetime_local,
|
|
None)
|
|
|
|
resp.text = json.dumps(result)
|