PR for Database changes

src/scripts/testData.sh

@@ -54,21 +54,21 @@ sed -i "" -e "s/^[0-9]/313,&/" src/server/test/db/data/automatedTests/15Freq7Amp
 # This will probably not be necesary once can use curl to get the files in
 # CSV with meter info
 cat > $postgresdir/testMeters.csv << EOF
-id,name,ipaddress,enabled,displayable,meter_type,default_timezone_meter,gps,identifier
-300,test4DaySin,123.45.6.0,FALSE,TRUE,mamac,,,test4DaySin
-301,test4HourSin,123.45.6.0,FALSE,TRUE,mamac,,,test4HourSin
-302,test23MinSin,123.45.6.0,FALSE,TRUE,mamac,,,test23MinSin
-303,test15MinSin,123.45.6.0,FALSE,TRUE,mamac,,,test15MinSin
-304,test23MinCos,123.45.6.0,FALSE,TRUE,mamac,,,test23MinCos
-305,testSqSin,123.45.6.0,FALSE,TRUE,mamac,,,testSqSin
-306,testSqCos,123.45.6.0,FALSE,TRUE,mamac,,,testSqCos
-307,testAmp1Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp1Sin
-308,testAmp2Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp2Sin
-309,testAmp3Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp3Sin
-310,testAmp4Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp4Sin
-311,testAmp5Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp5Sin
-312,testAmp6Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp6Sin
-313,testAmp7Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp7Sin
+id,name,ipaddress,enabled,displayable,meter_type,default_timezone_meter,gps,identifier,note,area,cumulative,cumulative_reset,cumulative_reset_start,cumulative_reset_end,reading_length,reading_variation,reading,start_timestamp,end_timestamp
+300,test4DaySin,123.45.6.0,FALSE,TRUE,mamac,,,test4DaySin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+301,test4HourSin,123.45.6.0,FALSE,TRUE,mamac,,,test4HourSin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+302,test23MinSin,123.45.6.0,FALSE,TRUE,mamac,,,test23MinSin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+303,test15MinSin,123.45.6.0,FALSE,TRUE,mamac,,,test15MinSin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+304,test23MinCos,123.45.6.0,FALSE,TRUE,mamac,,,test23MinCos,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+305,testSqSin,123.45.6.0,FALSE,TRUE,mamac,,,testSqSin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+306,testSqCos,123.45.6.0,FALSE,TRUE,mamac,,,testSqCos,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+307,testAmp1Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp1Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+308,testAmp2Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp2Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+309,testAmp3Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp3Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+310,testAmp4Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp4Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+311,testAmp5Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp5Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+312,testAmp6Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp6Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
+313,testAmp7Sin,123.45.6.0,FALSE,TRUE,mamac,,,testAmp7Sin,notesTest,25.0,FALSE,TRUE,00:00:00,00:00:00,,,20.0,,0001-01-01 : 00:00:00
 EOF
 # Put meters into OED
 docker-compose exec database psql -U oed  -c "copy meters from 'testMeters.csv' CSV HEADER"

src/server/migrations/0.6.0-0.7.0/sql/group/add_displayable_gps_note_area_columns.sql

@@ -0,0 +1,10 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+ALTER TABLE groups
+	ADD COLUMN IF NOT EXISTS displayable BOOLEAN,
+    ADD COLUMN IF NOT EXISTS gps POINT DEFAULT NULL,
+    ADD COLUMN IF NOT EXISTS note TEXT,
+    ADD COLUMN IF NOT EXISTS area REAL DEFAULT NULL;
+

src/server/migrations/0.6.0-0.7.0/sql/map/add_north_angle_and_circle_fraction.sql

@@ -0,0 +1,7 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+ALTER TABLE maps
+	ADD COLUMN IF NOT EXISTS north_angle REAL DEFAULT 0.0,
+	ADD COLUMN IF NOT EXISTS max_circle_size_fraction REAL DEFAULT 0.15;

src/server/migrations/0.6.0-0.7.0/sql/meter/add_multiple_db_meters_columns.sql

@@ -0,0 +1,18 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+ALTER TABLE meters
+	ADD COLUMN IF NOT EXISTS note TEXT,
+    ADD COLUMN IF NOT EXISTS area REAL DEFAULT NULL,
+    ADD COLUMN IF NOT EXISTS cumulative BOOLEAN DEFAULT false,
+    ADD COLUMN IF NOT EXISTS cumulative_reset BOOLEAN DEFAULT false,
+    ADD COLUMN IF NOT EXISTS cumulative_reset_start TIME DEFAULT '00:00:00',
+    ADD COLUMN IF NOT EXISTS cumulative_reset_end TIME DEFAULT '23:59:59.999999',
+    ADD COLUMN IF NOT EXISTS reading_length TIME DEFAULT '00:00:00',
+    ADD COLUMN IF NOT EXISTS reading_variation TIME DEFAULT '23:59:59.999999',
+    ADD COLUMN IF NOT EXISTS reading REAL DEFAULT 0.0,
+    ADD COLUMN IF NOT EXISTS start_timestamp TIMESTAMP DEFAULT '0001-01-01 00:00:00',
+    ADD COLUMN IF NOT EXISTS end_timestamp TIMESTAMP DEFAULT '0001-01-01 00:00:00'
+    ;
+

src/server/models/Group.js

@@ -12,10 +12,18 @@ class Group {
 	/**
 	 * @param id should be undefined when creating a new group
 	 * @param name group's name
+	 * @param displayable The group is available for display
+	 * @param gps Location in format of GIS coordinates, default null
+	 * @param note Note about the group
+	 * @param area Area of the group, default null
 	 */
-	constructor(id, name) {
+	constructor(id, name, displayable, gps, note, area) {
 		this.id = id;
 		this.name = name;
+		this.displayable = displayable;
+		this.gps = gps;
+		this.note = note;
+		this.area = area;
 	}
 
 	/**
@@ -48,7 +56,7 @@ class Group {
 	 * @returns {Group}
 	 */
 	static mapRow(row) {
-		return new Group(row.id, row.name);
+		return new Group(row.id, row.name, row.displayable, row.gps, row.note, row.area);
 	}
 
 	/**

src/server/models/Map.js

@@ -17,8 +17,10 @@ class Map {
 	 * @param origin {Point} coordinates of (0,0) on map
 	 * @param opposite {Point} coordinates of opposite corner from origin
 	 * @param mapSource data URL of image of the map
+	 * @param northAngle stores angle between map orientation and true north, default 0.0
+	 * @param maxCircleSizeFraction Stores the fraction of horizontal map, default 0.15
 	 */
-	constructor(id, name, displayable, note, filename, modifiedDate, origin, opposite, mapSource) {
+	constructor(id, name, displayable, note, filename, modifiedDate, origin, opposite, mapSource, northAngle, maxCircleSizeFraction) {
 		this.id = id;
 		this.name = name;
 		this.displayable = displayable;
@@ -28,6 +30,8 @@ class Map {
 		this.origin = origin;
 		this.opposite = opposite;
 		this.mapSource = mapSource;
+		this.northAngle = northAngle;
+		this.maxCircleSizeFraction = maxCircleSizeFraction;
 	}
 
 	/**
@@ -73,7 +77,8 @@ class Map {
 	 * @returns {Map}
 	 */
 	static mapRow(row) {
-		return new Map(row.id, row.name, row.displayable, row.note, row.filename, row.modified_date, row.origin, row.opposite, row.map_source);
+		return new Map(row.id, row.name, row.displayable, row.note, row.filename, 
+			row.modified_date, row.origin, row.opposite, row.map_source, row.north_angle, row.max_circle_size_fraction);
 	}
 
 	/**

src/server/models/Meter.js

@@ -18,8 +18,21 @@ class Meter {
 	 * @param gps location in format of GIS coordinates
 	 * @param meterTimezone Default timezone for meter
 	 * @param identifier Another way to identify a meter
+	 * @param note Note about the meter
+	 * @param area Area of the meter default null
+	 * @param cumulative Identifies if meter readings that are stored are the sum of usage or the particular reading, default false
+	 * @param cumulativeReset True if cumulative values can reset back to zero., default false
+	 * @param cumulativeResetStart The earliest time of day that a reset can occur, default '00:00:00'
+	 * @param cumulativeResetEnd The latest time of day that a reset can occur, default '23:59:59.999999'
+	 * @param readingLength Specifies the time range on every reading in the CSV file, default '00:00:00'
+	 * @param readingVariation +/- time allowed on length to consider within allowed length, default '23:59:59.999999'
+	 * @param reading The value of reading, default 0.0
+	 * @param startTimestamp Start timestamp of last reading input for this meter, default '01-01-01 00:00:00'
+	 * @param endTimestamp  End timestamp of last reading input for this meter, '01-01-01 00:00:00' 
 	 */
-	constructor(id, name, ipAddress, enabled, displayable, type, meterTimezone, gps = undefined, identifier = name) {
+	constructor(id, name, ipAddress, enabled, displayable, type, meterTimezone, gps = undefined, identifier = name, note, area,
+		cumulative, cumulativeReset, cumulativeResetStart, cumulativeResetEnd, readingLength, readingVariation, reading, 
+		startTimestamp, endTimestamp) {
 		this.id = id;
 		this.name = name;
 		this.ipAddress = ipAddress;
@@ -29,6 +42,17 @@ class Meter {
 		this.gps = gps;
 		this.meterTimezone = meterTimezone;
 		this.identifier = identifier;
+		this.note = note;
+		this.area = area;
+		this.cumulative = cumulative;
+		this.cumulativeReset = cumulativeReset;
+		this.cumulativeResetStart = cumulativeResetStart;
+		this.cumulativeResetEnd = cumulativeResetEnd;
+		this.readingLength = readingLength;
+		this.readingVariation = readingVariation;
+		this.reading = reading;
+		this.startTimestamp = startTimestamp;
+		this.endTimestamp = endTimestamp;
 	}
 
 	/**
@@ -78,7 +102,9 @@ class Meter {
 	 */
 	static mapRow(row) {
 		return new Meter(row.id, row.name, row.ipaddress, row.enabled, row.displayable, row.meter_type,
-			row.default_timezone_meter, row.gps, row.identifier);
+			row.default_timezone_meter, row.gps, row.identifier, row.note, row.area, row.cumulative, row.cumulative_reset,
+			row.cumulative_reset_start, row.cumulative_reset_end, row.reading_length, row.reading_variation, 
+			row.reading, row.start_timestamp, row.end_timestamp);
 	}
 
 	/**

src/server/routes/maps.js

@@ -26,7 +26,9 @@ function formatMapForResponse(map) {
 		modifiedDate: map.modifiedDate,
 		origin: map.origin,
 		opposite: map.opposite,
-		mapSource: map.mapSource
+		mapSource: map.mapSource,
+		northAngle: map.northAngle,
+		maxCircleSizeFraction: map.maxCircleSizeFraction
 	};
 	return formattedMap;
 }

src/server/routes/meters.js

@@ -32,15 +32,37 @@ function formatMeterForResponse(meter, loggedInAsAdmin) {
 		meterType: null,
 		timeZone: null,
 		gps: meter.gps,
-		identifier: meter.identifier
+		identifier: meter.identifier,
+		area: meter.area,
+		note: null,
+		cumulative: null,
+		cumulativeReset : null,
+		cumulativeResetStart : null,
+		cumulativeResetEnd : null,
+		readingLength : null,
+		readingVariation : null,
+		reading : null,
+		startTimestamp : null,
+		endTimestamp : null
 	};
 
 	// Only logged in Admins can see IP addresses, types, timezones, and internal names
+	// and lots of other items now.
 	if (loggedInAsAdmin) {
 		formattedMeter.ipAddress = meter.ipAddress;
 		formattedMeter.meterType = meter.type;
 		formattedMeter.timeZone = meter.meterTimezone;
 		formattedMeter.name = meter.name;
+		formattedMeter.note = meter.note;
+		formattedMeter.cumulative = meter.cumulative;
+		formattedMeter.cumulativeReset = meter.cumulativeReset;
+		formattedMeter.cumulativeResetStart = meter.cumulativeResetStart;
+		formattedMeter.cumulativeResetEnd = meter.cumulativeResetEnd;
+		formattedMeter.readingLength = meter.readingLength;
+		formattedMeter.readingVariation = meter.readingVariation;
+		formattedMeter.reading = meter.reading;
+		formattedMeter.startTimestamp = meter.startTimestamp;
+		formattedMeter.endTimestamp = meter.endTimestamp;
 	}
 
 	// TODO: remove this line when usages of meter.name are replaced with meter.identifer

src/server/sql/group/create_groups_tables.sql

@@ -4,7 +4,11 @@
 
 CREATE TABLE IF NOT EXISTS groups (
 	id SERIAL PRIMARY KEY NOT NULL,
-	name VARCHAR(50) UNIQUE NOT NULL CHECK (char_length(name) >= 1)
+	name VARCHAR(50) UNIQUE NOT NULL CHECK (char_length(name) >= 1),
+	displayable BOOLEAN,
+	gps POINT DEFAULT NULL,
+	note TEXT,
+	area REAL DEFAULT NULL
 );
 
 /*

src/server/sql/group/get_all_groups.sql

@@ -1,4 +1,4 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-SELECT id, name FROM groups;
+SELECT id, name, displayable, gps, note, area FROM groups;

src/server/sql/group/get_group_by_id.sql

@@ -1,4 +1,4 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-SELECT id, name FROM groups WHERE id=${id};
+SELECT id, name, displayable, gps, note, area FROM groups WHERE id=${id};

src/server/sql/group/get_group_by_name.sql

@@ -1,4 +1,4 @@
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-SELECT id, name FROM groups WHERE name=${name};
+SELECT id, name, displayable, gps, note, area FROM groups WHERE name=${name};

src/server/sql/group/insert_new_group.sql

@@ -3,4 +3,6 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
-INSERT INTO groups (name) VALUES (${name}) RETURNING id;
+INSERT INTO groups (name, displayable, gps, note, area) 
+VALUES (${name}, ${displayable}, ${gps}, ${note}, ${area}) 
+RETURNING id;

src/server/sql/map/create_maps_table.sql

@@ -6,10 +6,12 @@ CREATE TABLE IF NOT EXISTS maps (
 	id SERIAL PRIMARY KEY,
 	name VARCHAR(50) UNIQUE NOT NULL,
 	displayable boolean NOT NULL,
-	note VARCHAR(500),
+	note TEXT,
 	filename VARCHAR(200) NOT NULL,
 	modified_date TIMESTAMP NOT NULL,
 	origin POINT DEFAULT NULL,
 	opposite POINT DEFAULT NULL,
-	map_source TEXT NOT NULL
+	map_source TEXT NOT NULL,
+	north_angle REAL DEFAULT 0.0,
+	max_circle_size_fraction REAL DEFAULT 0.15
 );

src/server/sql/map/get_map_by_id.sql

@@ -2,5 +2,5 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-SELECT id, name, displayable, note, filename, modified_date, origin, opposite, map_source FROM maps
+SELECT id, name, displayable, note, filename, modified_date, origin, opposite, map_source, north_angle, max_circle_size_fraction FROM maps
     WHERE id=${id};

src/server/sql/map/get_map_by_name.sql

@@ -2,5 +2,5 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-SELECT id, name, displayable, note, filename, modified_date, origin, opposite, map_source FROM maps
+SELECT id, name, displayable, note, filename, modified_date, origin, opposite, map_source, north_angle, max_circle_size_fraction FROM maps
     WHERE name=${name};

src/server/sql/map/insert_new_map.sql

@@ -4,6 +4,6 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
- INSERT INTO maps(name, displayable, note, filename, modified_date, origin, opposite, map_source)
- 	VALUES (${name}, ${displayable}, ${note}, ${filename}, ${modifiedDate}, ${origin}, ${opposite}, ${mapSource})
+ INSERT INTO maps(name, displayable, note, filename, modified_date, origin, opposite, map_source, north_angle, max_circle_size_fraction)
+ 	VALUES (${name}, ${displayable}, ${note}, ${filename}, ${modifiedDate}, ${origin}, ${opposite}, ${mapSource}, ${northAngle}, ${maxCircleSizeFraction})
 	RETURNING id;

src/server/sql/map/update_map.sql

@@ -10,5 +10,7 @@ UPDATE maps
 		modified_date = ${modifiedDate},
 		origin = ${origin},
 		opposite = ${opposite},
-		map_source = ${mapSource}
+		map_source = ${mapSource},
+		north_angle = ${northAngle},
+		max_circle_size_fraction = ${maxCircleSizeFraction}
 	WHERE id = ${id};

src/server/sql/meter/create_meters_table.sql

@@ -5,23 +5,45 @@
 /*
 Creates a table of meters containing 
 primary key (generally set by DB,
-the name of a meter used for getting data and currently shown to user,
-IP address for meter data,
-enabled true if the meter should get data,
-displayable true if meter visible to non-admin users,
-the meter type,
-the time zone for this meter (if null then use site value),
-gps location of this meter,
-identifier is name that will be shown to user in future
+name: The name of a meter used for getting data and currently shown to user,
+IP addresF: for meter data,
+enabled: True if the meter should get data,
+displayable: True if meter visible to non-admin users,
+meter_type: The meter type,
+timezone: The time zone for this meter (if null then use site value),
+gps: Location of this meter,
+identifier: Is name that will be shown to user in future
+note: Notes about the meter
+area: Area covered by the meter
+cumulative: True if cumulative values can reset back to zero
+cumulative_reset: True if pipline is to be reset
+cumulative_reset_start: The earliest time of day that a reset can occur
+cumulative_reset_end: The latest time of day that a reset can occur
+reading_length: Specify the time range on every reading
+reading_variation: +/- time allowed on length to consider within allowed length
+reading: The last reading input for the meter
+start_timestamp: Start timestamp of last reading input for this meter
+end_timestamp: End timestamp of last reading for this meter
 */
 CREATE TABLE IF NOT EXISTS meters (
-	id SERIAL PRIMARY KEY,
-	name VARCHAR(50) UNIQUE NOT NULL,
-	ipAddress VARCHAR(20),
-	enabled BOOLEAN NOT NULL,
-	displayable BOOLEAN NOT NULL,
-	meter_type meter_type NOT NULL,
-	default_timezone_meter TEXT DEFAULT NULL,
-	gps POINT DEFAULT NULL,
-	identifier TEXT
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(50) UNIQUE NOT NULL,
+    ipAddress VARCHAR(20),
+    enabled BOOLEAN NOT NULL,
+    displayable BOOLEAN NOT NULL,
+    meter_type meter_type NOT NULL,
+    default_timezone_meter TEXT DEFAULT NULL,
+    gps POINT DEFAULT NULL,
+    identifier TEXT UNIQUE NOT NULL,
+    note TEXT,
+    area REAL DEFAULT NULL,
+    cumulative BOOLEAN DEFAULT false,
+    cumulative_reset BOOLEAN DEFAULT false,
+    cumulative_reset_start TIME DEFAULT '00:00:00',
+    cumulative_reset_end TIME DEFAULT '23:59:59.999999',
+    reading_length TIME DEFAULT '00:00:00',
+    reading_variation TIME DEFAULT '23:59:59.999999',
+    reading REAL DEFAULT 0.0,
+    start_timestamp TIMESTAMP DEFAULT '0001-01-01 00:00:00',
+    end_timestamp TIMESTAMP DEFAULT '0001-01-01 00:00:00'
 );

src/server/sql/meter/get_meter_by_id.sql

@@ -2,5 +2,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-SELECT id, name, ipaddress, enabled, displayable, meter_type, default_timezone_meter, gps, identifier FROM meters
-    WHERE id=${id};
+SELECT id, name, ipaddress, enabled, displayable, meter_type, default_timezone_meter, gps, identifier,
+    note, area, cumulative, cumulative_reset, cumulative_reset_start, cumulative_reset_end,
+    reading_length, reading_variation, reading, start_timestamp, end_timestamp
+FROM meters
+WHERE id=${id};