implemented virtual point calculating in myems-normalization service

Merge branch 'develop'
pull/43/MERGE
13621160019@163.com 2021-05-08 13:38:41 +08:00
commit 00eff6582c
5 changed files with 351 additions and 38 deletions

View File

@ -1091,15 +1091,15 @@ Result in JSON
| Name | Data Type | Description |
|---------------|-----------|-------------------------------------------|
| id | integer | Point ID |
| name | string | Point name |
| name | string | Point Name |
| data_source | object | Data Source Object |
| object_type | string | Object Type ('ENERGY_VALUE', 'ANALOG_VALUE, 'BINARY_VALUE') |
| object_type | string | Object Type ('ENERGY_VALUE', 'ANALOG_VALUE', 'BINARY_VALUE') |
| units | string | Units of Measure |
| high_limit | float | High Limit of the Point Value |
| low_limit | float | Low Limit of the Point Value |
| ratio | float | Raw value will be multiplied by ratio value. It is not applicable to virtual point. | |
| is_trend | boolean | Indicates that trend value will be saved | |
| is_virtual | boolean | Indicates that it is a virtual point |
| is_trend | boolean | Indicates that trend value will be saved |
| is_virtual | boolean | Indicates a virtual point. It is only applicable to object type 'ANALOG_VALUE'|
| address | json | Address structure varied by protocol |
| | | Modbus TCP Structure |
| ├slave_id | integer | Slave ID |
@ -1112,6 +1112,9 @@ Result in JSON
| ├object_id | integer | BACnet Object Instance Number |
| ├property_name| string | BACnet Property Name ('presentValue') |
| └property_array_index| integer/null | BACnet Property Array Index or None of Object Type is not Array |
| | | Virtual Point Structure |
| ├expression | string | Expression |
| └substitutions| string | Substitutions |
| description | string | Point description, allow null |
* GET all Points

View File

@ -127,6 +127,9 @@ class PointCollection:
not isinstance(new_values['data']['is_virtual'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_VIRTUAL_VALUE')
if new_values['data']['is_virtual'] is True and object_type != 'ANALOG_VALUE':
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.VIRTUAL_POINT_SHOULD_BE_ANALOG_VALUE')
is_virtual = new_values['data']['is_virtual']
if 'address' not in new_values['data'].keys() or \
@ -456,6 +459,9 @@ class PointItem:
not isinstance(new_values['data']['is_virtual'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_VIRTUAL_VALUE')
if new_values['data']['is_virtual'] is True and object_type != 'ANALOG_VALUE':
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.VIRTUAL_POINT_SHOULD_BE_ANALOG_VALUE')
is_virtual = new_values['data']['is_virtual']
if 'address' not in new_values['data'].keys() or \

View File

@ -4,6 +4,7 @@ from multiprocessing import Process
import meter
import offlinemeter
import virtualmeter
import virtualpoint
def main():
@ -25,8 +26,10 @@ def main():
# calculate energy consumption in hourly period
Process(target=meter.calculate_hourly, args=(logger,)).start()
Process(target=virtualmeter.calculate_hourly, args=(logger,)).start()
Process(target=offlinemeter.calculate_hourly, args=(logger,)).start()
Process(target=virtualmeter.calculate_hourly, args=(logger,)).start()
# calculate virtual point value
Process(target=virtualpoint.calculate, args=(logger,)).start()
if __name__ == '__main__':

View File

@ -168,16 +168,16 @@ def worker(virtual_meter):
# Step 2: parse the expression and get all meters, virtual meters, and
# offline meters associated with the expression
############################################################################################################
cnx_factory_db = None
cursor_factory_db = None
cnx_system_db = None
cursor_system_db = None
try:
cnx_factory_db = mysql.connector.connect(**config.myems_system_db)
cursor_factory_db = cnx_factory_db.cursor()
cnx_system_db = mysql.connector.connect(**config.myems_system_db)
cursor_system_db = cnx_system_db.cursor()
except Exception as e:
if cursor_factory_db:
cursor_factory_db.close()
if cnx_factory_db:
cnx_factory_db.close()
if cursor_system_db:
cursor_system_db.close()
if cnx_system_db:
cnx_system_db.close()
if cursor_energy_db:
cursor_energy_db.close()
if cnx_energy_db:
@ -192,13 +192,13 @@ def worker(virtual_meter):
# get all meters associated with the expression
########################################################################################################
cursor_factory_db.execute(" SELECT m.id as meter_id, v.name as variable_name "
" FROM tbl_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'], ))
rows = cursor_factory_db.fetchall()
cursor_system_db.execute(" SELECT m.id as meter_id, v.name as variable_name "
" FROM tbl_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'], ))
rows = cursor_system_db.fetchall()
if rows is not None and len(rows) > 0:
for row in rows:
meter_list_in_expression.append({"meter_id": row[0], "variable_name": row[1].lower()})
@ -207,13 +207,13 @@ def worker(virtual_meter):
# get all virtual meters associated with the expression
########################################################################################################
cursor_factory_db.execute(" SELECT m.id as virtual_meter_id, v.name as variable_name "
" FROM tbl_virtual_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'virtual_meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'],))
rows = cursor_factory_db.fetchall()
cursor_system_db.execute(" SELECT m.id as virtual_meter_id, v.name as variable_name "
" FROM tbl_virtual_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'virtual_meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'],))
rows = cursor_system_db.fetchall()
if rows is not None and len(rows) > 0:
for row in rows:
virtual_meter_list_in_expression.append({"virtual_meter_id": row[0],
@ -223,13 +223,13 @@ def worker(virtual_meter):
# get all offline meters associated with the expression
########################################################################################################
cursor_factory_db.execute(" SELECT m.id as offline_meter_id, v.name as variable_name "
" FROM tbl_offline_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'offline_meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'],))
rows = cursor_factory_db.fetchall()
cursor_system_db.execute(" SELECT m.id as offline_meter_id, v.name as variable_name "
" FROM tbl_offline_meters m, tbl_variables v "
" WHERE m.id = v.meter_id "
" AND v.meter_type = 'offline_meter' "
" AND v.expression_id = %s ",
(virtual_meter['expression_id'],))
rows = cursor_system_db.fetchall()
if rows is not None and len(rows) > 0:
for row in rows:
offline_meter_list_in_expression.append({"offline_meter_id": row[0],
@ -241,10 +241,10 @@ def worker(virtual_meter):
cnx_energy_db.close()
return "Error in step 2.2 of virtual meter worker " + str(e) + " for '" + virtual_meter['name'] + "'"
finally:
if cursor_factory_db:
cursor_factory_db.close()
if cnx_factory_db:
cnx_factory_db.close()
if cursor_system_db:
cursor_system_db.close()
if cnx_system_db:
cnx_system_db.close()
############################################################################################################
# Step 3: query energy consumption values from table meter hourly, virtual meter hourly

View File

@ -0,0 +1,301 @@
import time
from datetime import datetime, timedelta
import mysql.connector
from sympy import sympify
from multiprocessing import Pool
import random
import json
import config
########################################################################################################################
# PROCEDURES:
# Step 1: Query all virtual points
# Step 2: Create multiprocessing pool to call worker in parallel
########################################################################################################################
def calculate(logger):
while True:
# outer loop to reconnect server if there is a connection error
cnx_system_db = None
cursor_system_db = None
try:
cnx_system_db = mysql.connector.connect(**config.myems_system_db)
cursor_system_db = cnx_system_db.cursor(dictionary=True)
except Exception as e:
logger.error("Error in step 0 of virtual point calculate " + str(e))
if cursor_system_db:
cursor_system_db.close()
if cnx_system_db:
cnx_system_db.close()
# sleep and continue the outer loop to reconnect the database
time.sleep(60)
continue
print("Connected to MyEMS System Database")
virtual_point_list = list()
try:
cursor_system_db.execute(" SELECT id, name, data_source_id, high_limit, low_limit, address "
" FROM tbl_points "
" WHERE is_virtual = TRUE AND object_type = 'ANALOG_VALUE' ")
rows_virtual_points = cursor_system_db.fetchall()
if rows_virtual_points is None or len(rows_virtual_points) == 0:
# sleep several minutes and continue the outer loop to reconnect the database
time.sleep(60)
continue
for row in rows_virtual_points:
meta_result = {"id": row['id'],
"name": row['name'],
"data_source_id": row['data_source_id'],
"high_limit": row['high_limit'],
"low_limit": row['low_limit'],
"address": row['address']}
virtual_point_list.append(meta_result)
except Exception as e:
logger.error("Error in step 1 of virtual point calculate " + str(e))
# sleep and continue the outer loop to reconnect the database
time.sleep(60)
continue
finally:
if cursor_system_db:
cursor_system_db.close()
if cnx_system_db:
cnx_system_db.close()
# shuffle the virtual point list for randomly calculating
random.shuffle(virtual_point_list)
print("Got all virtual points in MyEMS System Database")
################################################################################################################
# Step 2: Create multiprocessing pool to call worker in parallel
################################################################################################################
p = Pool(processes=config.pool_size)
error_list = p.map(worker, virtual_point_list)
p.close()
p.join()
for error in error_list:
if error is not None and len(error) > 0:
logger.error(error)
print("go to sleep ...")
time.sleep(60)
print("wake from sleep, and continue to work...")
########################################################################################################################
# Step 1: get start datetime and end datetime
# Step 2: parse the expression and get all points in substitutions
# Step 3: query points value from historical database
# Step 4: evaluate the equation with points values
########################################################################################################################
def worker(virtual_point):
cnx_historical_db = None
cursor_historical_db = None
try:
cnx_historical_db = mysql.connector.connect(**config.myems_historical_db)
cursor_historical_db = cnx_historical_db.cursor()
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 1.1 of virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
print("Start to process virtual point: " + "'" + virtual_point['name']+"'")
####################################################################################################################
# step 1: get start datetime and end datetime
####################################################################################################################
try:
query = (" SELECT MAX(utc_date_time) "
" FROM tbl_analog_value "
" WHERE point_id = %s ")
cursor_historical_db.execute(query, (virtual_point['id'],))
row = cursor_historical_db.fetchone()
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 1.2 of virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
start_datetime_utc = datetime.strptime(config.start_datetime_utc, '%Y-%m-%d %H:%M:%S')
start_datetime_utc = start_datetime_utc.replace(minute=0, second=0, microsecond=0, tzinfo=None)
if row is not None and len(row) > 0 and isinstance(row[0], datetime):
# replace second and microsecond with 0
# note: do not replace minute in case of calculating in half hourly
start_datetime_utc = row[0].replace(second=0, microsecond=0, tzinfo=None)
# start from the next time slot
start_datetime_utc += timedelta(minutes=config.minutes_to_count)
end_datetime_utc = datetime.utcnow().replace()
end_datetime_utc = end_datetime_utc.replace(second=0, microsecond=0, tzinfo=None)
if end_datetime_utc <= start_datetime_utc:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "it's too early to calculate" + " for '" + virtual_point['name'] + "'"
print("start_datetime_utc: " + start_datetime_utc.isoformat()[0:19]
+ "end_datetime_utc: " + end_datetime_utc.isoformat()[0:19])
############################################################################################################
# Step 2: parse the expression and get all points in substitutions
############################################################################################################
point_list = list()
try:
########################################################################################################
# parse the expression and get all points in substitutions
########################################################################################################
address = json.loads(virtual_point['address'])
# example: '{"expression": "x1-x2", "substitutions": {"x1":1,"x2":2}}'
if 'expression' not in address.keys() \
or 'substitutions' not in address.keys() \
or len(address['expression']) == 0 \
or len(address['substitutions']) == 0:
return "Error in step 2.1 of virtual point worker for '" + virtual_point['name'] + "'"
expression = address['expression']
substitutions = address['substitutions']
for variable_name, point_id in substitutions.items():
point_list.append({"variable_name": variable_name, "point_id": point_id})
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 2.2 of virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
############################################################################################################
# Step 3: query points value from historical database
############################################################################################################
print("getting point values ...")
point_values_dict = dict()
if point_list is not None and len(point_list) > 0:
try:
for point in point_list:
point_id = str(point['point_id'])
query = (" SELECT utc_date_time, actual_value "
" FROM tbl_analog_value "
" WHERE point_id = %s AND utc_date_time >= %s AND utc_date_time < %s "
" ORDER BY utc_date_time ")
cursor_historical_db.execute(query, (point_id, start_datetime_utc, end_datetime_utc, ))
rows = cursor_historical_db.fetchall()
if rows is None or len(rows) == 0:
point_values_dict[point_id] = None
else:
point_values_dict[point_id] = dict()
for row in rows:
point_values_dict[point_id][row[0]] = row[1]
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 3.1 virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
############################################################################################################
# Step 4: evaluate the equation with points values
############################################################################################################
print("getting date time set for all points...")
utc_date_time_set = set()
if point_values_dict is not None and len(point_values_dict) > 0:
for point_id, point_values in point_values_dict.items():
if point_values is not None and len(point_values) > 0:
utc_date_time_set = utc_date_time_set.union(point_values.keys())
print("evaluating the equation with SymPy...")
normalized_values = list()
############################################################################################################
# Converting Strings to SymPy Expressions
# The sympify function(thats sympify, not to be confused with simplify) can be used to
# convert strings into SymPy expressions.
############################################################################################################
try:
expr = sympify(expression)
print("the expression to be evaluated: " + str(expr))
for utc_date_time in utc_date_time_set:
meta_data = dict()
meta_data['utc_date_time'] = utc_date_time
####################################################################################################
# create a dictionary of Symbol: point pairs
####################################################################################################
subs = dict()
####################################################################################################
# Evaluating the expression at current_datetime_utc
####################################################################################################
if point_list is not None and len(point_list) > 0:
for point in point_list:
point_id = str(point['point_id'])
actual_value = point_values_dict[point_id].get(utc_date_time, None)
if actual_value is None:
break
subs[point['variable_name']] = actual_value
if len(subs) != len(point_list):
continue
####################################################################################################
# To numerically evaluate an expression with a Symbol at a point,
# we might use subs followed by evalf,
# but it is more efficient and numerically stable to pass the substitution to evalf
# using the subs flag, which takes a dictionary of Symbol: point pairs.
####################################################################################################
meta_data['actual_value'] = expr.evalf(subs=subs)
normalized_values.append(meta_data)
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 4.1 virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
print("saving virtual points values to historical database...")
if len(normalized_values) > 0:
try:
add_values = (" INSERT INTO tbl_analog_value "
" (point_id, utc_date_time, actual_value) "
" VALUES ")
for meta_data in normalized_values:
add_values += " (" + str(virtual_point['id']) + ","
add_values += "'" + meta_data['utc_date_time'].isoformat()[0:19] + "',"
add_values += str(meta_data['actual_value']) + "), "
print("add_values:" + add_values)
# trim ", " at the end of string and then execute
cursor_historical_db.execute(add_values[:-2])
cnx_historical_db.commit()
except Exception as e:
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return "Error in step 4.2 virtual point worker " + str(e) + " for '" + virtual_point['name'] + "'"
if cursor_historical_db:
cursor_historical_db.close()
if cnx_historical_db:
cnx_historical_db.close()
return None