@measurequick/measurequick-report-generator 1.0.0

package/assets/request.json

@@ -0,0 +1,240 @@
+{
+    "meta": {
+        "reportName": "Test Report",
+        "reportType": "cooling",
+        "reportTheme": "dark",
+        "techName": "David Zucco",
+        "profilePicturePlacement": "header",
+        "companyLogoPlacement": "header"
+    },
+    "units": {
+        "temperature": "F",
+        "pressure": "PSIG",
+        "airflow": "SCFM"
+    },
+    "values": {
+        "lowSidePressure": "",
+        "lowSideTemperature": "",
+        "highSidePressure": "",
+        "highSideTemperature": "",
+        "suctionLineTemperature": "",
+        "liquidLineTemperature": "",
+        "dischargeLineTemperature": "",
+        "outdoorAirTemperature": "",
+        "superheatTemperature": "",
+        "subcoolingTemperature": "",
+        "compressionRatio": "",
+        "condenserVoltageL1": "",
+        "condenserVoltageL2": "",
+        "condenserAmperageL1": "",
+        "condenserAmperageL2": "",
+        "condenserPowerFactor": "",
+        "condenserPower": "",
+        "returnTemperature": "",
+        "returnRelativeHumidity": "",
+        "returnWetBulbTemperature": "",
+        "supplyTemperature": "",
+        "supplyRelativeHumidity": "",
+        "supplyWetBulb": "",
+        "airflowEstimated": "",
+        "totalExternalStaticPressure": "",
+        "airHandlerVoltageL1": "",
+        "airHandlerVoltageL2": "",
+        "airHandlerAmperageL1": "",
+        "airHandlerAmperageL2": "",
+        "airHandlerPowerFactor": "",
+        "airHandlerPower": "",
+        "systemType": "",
+        "nominalTonnage": "",
+        "refrigerant": "",
+        "airflowNominal": "",
+        "seer": "",
+        "meteringDevice": "",
+        "atmosphericPressure": "",
+        "elevation": "",
+        "temperature": "",
+        "humidity": "",
+        "dewPoint": "",
+        "systemStability": "",
+        "capacityNominal": "",
+        "capacityNormalized": "",
+        "capacityActual": "",
+        "capacityActualNormalized": "",
+        "capacitySensible": "",
+        "capacitySensibleNormalized": "",
+        "capacityLatent": "",
+        "capacityLatentNormalized": "",
+        "sensibleHeatRatio": "",
+        "temperatureSplitTarget": "",
+        "temperatureSplit": "",
+        "dehumidification": "",
+        "dehumidificationAlternate": "",
+        "fanEfficacy": "",
+        "totalPower": "",
+        "eer": "",
+        "seerApproximate": "",
+        "sensibleEfficiency": ""
+    },
+    "rangeIcons": {
+        "lowSidePressure": "",
+        "lowSideTemperature": "",
+        "highSidePressure": "",
+        "highSideTemperature": "",
+        "suctionLineTemperature": "",
+        "liquidLineTemperature": "",
+        "dischargeLineTemperature": "",
+        "outdoorAirTemperature": "",
+        "superheatTemperature": "",
+        "subcoolingTemperature": "",
+        "compressionRatio": "",
+        "condenserVoltageL1": "",
+        "condenserVoltageL2": "",
+        "condenserAmperageL1": "",
+        "condenserAmperageL2": "",
+        "condenserPowerFactor": "",
+        "condenserPower": "",
+        "returnTemperature": "",
+        "returnRelativeHumidity": "",
+        "returnWetBulbTemperature": "",
+        "supplyTemperature": "",
+        "supplyRelativeHumidity": "",
+        "supplyWetBulb": "",
+        "airflowEstimated": "",
+        "totalExternalStaticPressure": "",
+        "airHandlerVoltageL1": "",
+        "airHandlerVoltageL2": "",
+        "airHandlerAmperageL1": "",
+        "airHandlerAmperageL2": "",
+        "airHandlerPowerFactor": "",
+        "airHandlerPower": "",
+        "systemType": "",
+        "nominalTonnage": "",
+        "refrigerant": "",
+        "airflowNominal": "",
+        "seer": "",
+        "meteringDevice": "",
+        "atmosphericPressure": "",
+        "elevation": "",
+        "temperature": "",
+        "humidity": "",
+        "dewPoint": "",
+        "systemStability": "",
+        "capacityNominal": "",
+        "capacityNormalized": "",
+        "capacityActual": "",
+        "capacityActualNormalized": "",
+        "capacitySensible": "",
+        "capacitySensibleNormalized": "",
+        "capacityLatent": "",
+        "capacityLatentNormalized": "",
+        "sensibleHeatRatio": "",
+        "temperatureSplitTarget": "",
+        "temperatureSplit": "",
+        "dehumidification": "",
+        "dehumidificationAlternate": "",
+        "fanEfficacy": "",
+        "totalPower": "",
+        "eer": "",
+        "seerApproximate": "",
+        "sensibleEfficiency": ""
+    },
+    "toolIcons": {
+        "lowSidePressure": "",
+        "lowSideTemperature": "",
+        "highSidePressure": "",
+        "highSideTemperature": "",
+        "suctionLineTemperature": "",
+        "liquidLineTemperature": "",
+        "dischargeLineTemperature": "",
+        "outdoorAirTemperature": "",
+        "superheatTemperature": "",
+        "subcoolingTemperature": "",
+        "compressionRatio": "",
+        "condenserVoltageL1": "",
+        "condenserVoltageL2": "",
+        "condenserAmperageL1": "",
+        "condenserAmperageL2": "",
+        "condenserPowerFactor": "",
+        "condenserPower": "",
+        "returnTemperature": "",
+        "returnRelativeHumidity": "",
+        "returnWetBulbTemperature": "",
+        "supplyTemperature": "",
+        "supplyRelativeHumidity": "",
+        "supplyWetBulb": "",
+        "airflowEstimated": "",
+        "totalExternalStaticPressure": "",
+        "airHandlerVoltageL1": "",
+        "airHandlerVoltageL2": "",
+        "airHandlerAmperageL1": "",
+        "airHandlerAmperageL2": "",
+        "airHandlerPowerFactor": "",
+        "airHandlerPower": "",
+        "systemType": "",
+        "nominalTonnage": "",
+        "refrigerant": "",
+        "airflowNominal": "",
+        "seer": "",
+        "meteringDevice": "",
+        "atmosphericPressure": "",
+        "elevation": "",
+        "temperature": "",
+        "humidity": "",
+        "dewPoint": "",
+        "systemStability": "",
+        "capacityNominal": "",
+        "capacityNormalized": "",
+        "capacityActual": "",
+        "capacityActualNormalized": "",
+        "capacitySensible": "",
+        "capacitySensibleNormalized": "",
+        "capacityLatent": "",
+        "capacityLatentNormalized": "",
+        "sensibleHeatRatio": "",
+        "temperatureSplitTarget": "",
+        "temperatureSplit": "",
+        "dehumidification": "",
+        "dehumidificationAlternate": "",
+        "fanEfficacy": "",
+        "totalPower": "",
+        "eer": "",
+        "seerApproximate": "",
+        "sensibleEfficiency": ""
+    },
+    "footerData": {
+        "customerFirstName": "John"
+        "customerLastName": "Doe",
+        "customerAddressLine1": "1234 Test Avenue",
+        "customerAddressLine2": "Unit 6",
+        "customerCity": "Miami",
+        "customerState": "Florida",
+        "customerZip": "12345",
+        "customerEmail": "test@email.com",
+        "customerPhone": "123-456-7899",
+        "systemNumber": "123456789",
+        "systenName": "Test System",
+        "systemId": "9999999",
+        "systemLat": "13.24534534",
+        "systemLng": "87.34563465",
+        "systemType": "Split",
+        "systemMake": "Goodman",
+        "systemModel": "4582384532",
+        "systemSerial": "8459296520"
+    },
+    "photos": {
+        "profilePicture": "",
+        "companyLogo": "",
+        "userDocumented": {
+            "project": [
+                {
+                    "tag": "Condenser",
+                    "base64": ""
+                },
+                {
+                    "tag": "Evaporator",
+                    "base64": ""
+                }
+            ]
+        }
+    }
+}

package/assets/templates.js

@@ -0,0 +1,253 @@
+
+export const docOptions = {
+    orientation:    "portrait",
+    unit:           "in",
+    lineHeight:     1.25,
+    format:         "letter"
+};
+
+export const indoorMeasurements = {
+    "return_dry": {
+        "label": "Return Temp",
+        "units": "°F"
+    },
+    "return_rh": {
+        "label": "Return %RH"
+    },
+    "return_wet": {
+        "label": "Return Wet Bulb",
+        "units": "°F"
+    },
+    "supply_dry": {
+        "label": "Supply Temp",
+        "units": "°F"
+    },
+    "supply_rh": {
+        "label": "Supply %RH"
+    },
+    "supply_wet": {
+        "label": "Supply Wet Bulb",
+        "units": "°F"
+    },
+    "airflow_est": {
+        "label": "Airflow, Estimated",
+        "units": "SCFM"
+    },
+    "tesp": {
+        "label": "Total External Static Pres",
+        "units": "inH2O"
+    },
+    "voltage_ahu": {
+        "label": "Compression Ratio",
+        "secondaryValue": "voltage_ahu"
+    },
+    "amperage_ahu": {
+        "label": "Condenser Voltage",
+        "secondaryValue": "amperage_ahu"
+    },
+    "power_factor_ahu": {
+        "label": "Condenser Amperage"
+    },
+    "power_ahu": {
+        "label": "Condenser Power Factor",
+        "units": "W"
+    }
+};
+
+export const outdoorMeasurements = {
+    "pressure_evaporator": {
+        "label": "Low Pressure",
+        "units": ["PSIG", "°F"],
+        "secondaryValue": "pressure_evaporator"
+    },
+    "pressure_condenser": {
+        "label": "High Pressure",
+        "units": ["PSIG", "°F"],
+        "secondaryValue": "pressure_condenser"
+    },
+    "temperature_suction_line_condenser": {
+        "label": "Suction Line Temp",
+        "units": "°F"
+    },
+    "temperature_liquid_line": {
+        "label": "Liquid Line Temp",
+        "units": "°F"
+    },
+    "temperature_discharge_line": {
+        "label": "Discharge Line Temp",
+        "units": "°F"
+    },
+    "temperature_outdoor_air": {
+        "label": "Outdoor Air Temp",
+        "units": "°F"
+    },
+    "superheat": {
+        "label": "Superheat",
+        "units": "°F"
+    },
+    "subcooling": {
+        "label": "Subcooling",
+        "units": "°F"
+    },
+    "compression_ratio": {
+        "label": "Compression Ratio"
+    },
+    "voltage_l1": {
+        "label": "Condenser Voltage",
+        "secondaryValue": "voltage_l1"
+    },
+    "amperage_l1": {
+        "label": "Condenser Amperage",
+        "secondaryValue": "amperage_l1"
+    },
+    "power_factor": {
+        "label": "Condenser Power Factor"
+    },
+    "power_condenser": {
+        "label": "Condenser Power",
+        "units": "W"
+    }
+};
+
+export const performanceData = {
+
+    Nominal: 3.0 Tons / 36,000 Btu/h
+    Normalized: 2.9 Tons / 34,373 Btu/h
+    Actual: 0.9 Tons / 11,391 Btu/h
+    (33.1% Normalized)
+    Sensible: 0.6 Tons / 7,480 Btu/h
+    (82.3% Normalized)
+    Latent: 0.3 Tons / 3,910 Btu/h
+    (15.5% Normalized)
+    Sensible Heat Ratio: 0.66
+
+
+
+    Temp Split Target: 7.0°F
+    Temp Split: 8.1°F
+    Dehumidification: 3.6 lb/hr
+    0.4 gal/hr
+    Energy Efficiency:
+    Fan Efficacy: 1.16
+    Total Power: 3,587
+    EER: 3.2
+    Approx. SEER: 3.5
+    Sensible Efficiency: 82.3%
+
+    "pressure_evaporator": {
+        "label": "Low Pressure",
+        "units": ["PSIG", "°F"]
+    },
+    "pressure_condenser": {
+        "label": "High Pressure",
+        "units": ["PSIG", "°F"]
+    },
+    "temperature_suction_line_condenser": {
+        "label": "Suction Line Temp",
+        "units": "°F"
+    },
+    "temperature_liquid_line": {
+        "label": "Liquid Line Temp",
+        "units": "°F"
+    },
+    "temperature_discharge_line": {
+        "label": "Discharge Line Temp",
+        "units": "°F"
+    },
+    "temperature_outdoor_air": {
+        "label": "Outdoor Air Temp",
+        "units": "°F"
+    },
+    "superheat": {
+        "label": "Superheat",
+        "units": "°F"
+    },
+    "subcooling": {
+        "label": "Subcooling",
+        "units": "°F"
+    },
+    "compression_ratio": {
+        "label": "Compression Ratio"
+    },
+    "voltage_l1": {
+        "label": "Condenser Voltage"
+    },
+    "amperage_l1": {
+        "label": "Condenser Amperage"
+    },
+    "power_factor": {
+        "label": "Condenser Power Factor"
+    },
+    "power_condenser": {
+        "label": "Condenser Power",
+        "units": "W"
+    }
+};
+
+export const systemInfo = {
+    "system_type": {
+        "label": "System Type"
+    },
+    "tonnage": {
+        "label": "Nominal Tonnage"
+    },
+    "refrigerant": {
+        "label": "Refrigerant"
+    },
+    "airflow": {
+        "label": "Nom. Airflow",
+        "units": "SCFM/Ton"
+    },
+    "seer": {
+        "label": "SEER"
+    },
+    "metering_device": {
+        "label": "Metering Device"
+    },
+    "atmospheric_pressure": {
+        "label": "Atmospheric Pressure",
+        "units": "PSIA"
+    },
+    "elevation": {
+        "label": "Elevation",
+        "units": "ft"
+    },
+    "temperature": {
+        "label": "Temperature",
+        "units": "°F"
+    },
+    "humidity": {
+        "label": "Humidity",
+        "units": "%"
+    },
+    "dew_point": {
+        "label": "Dew Point",
+        "units": "°F"
+    },
+    "stability": {
+        "label": "System Stability"
+    }
+};
+
+export const footerData = [
+    "customerFirstName",
+    "customerLastName",
+    "customerAddressLine1",
+    "customerAddressLine2",
+    "customerCity",
+    "customerState",
+    "customerZip",
+    "customerEmail",
+    "customerPhone",
+    "systemNumber",
+    "systenName",
+    "systemId",
+    "systemLat",
+    "systemLng",
+    "systemType",
+    "systemMake",
+    "systemModel",
+    "systemSerial"
+];
+
+export const disclaimer = `Disclaimer: This report was prepared by your service technician who is solely responsible for its content.  This report is provided “as-is” excluding all warranties expressed or implied including without limitation the warranty of merchantability. ©2017-${new Date().getFullYear()} Manifold Cloud Services Ltd.`;

package/index.js

@@ -0,0 +1,152 @@
+
+import * as graphics from "./assets/graphics.js";
+import * as templates from "./assets/templates.js";
+import * as request from "./assets/request.json";
+
+jsPDF = require("jspdf/dist/jspdf.node.min");
+
+var doc = new jsPDF(templates.docOptions);
+
+export function getReport(reportData) {
+    try {
+        printBoilerPlate(reportData.meta.reportTheme);
+
+        var profilePicture = reportData.meta.profilePicturePlacement == "header" ? reportData.photos.profilePicture : null;
+        var companyLogo = reportData.meta.companyLogoPlacement == "header" ? reportData.photos.companyLogo : null;
+        printHeaderData(reportData.meta.reportName, reportData.meta.techName, profilePicture, companyLogo);
+
+        printBodyData();
+
+        profilePicture = reportData.meta.profilePicturePlacement == "footer" ? reportData.photos.profilePicture : null;
+        companyLogo = reportData.meta.companyLogoPlacement == "footer" ? reportData.photos.companyLogo : null;
+        printFooterData(reportData.meta.techName, profilePicture, companyLogo);
+
+        printPhotos(reportData.photos.userDocumented);
+
+        printInfoPage(reportData.meta.reportType);
+
+        return doc.output();
+    } catch (e) {
+        return doc.output();
+    }
+}
+
+function printBoilerPlate(theme) {
+    doc.addImage(graphics.headerMeasureQuick, "JPEG", 0, 0, 8.5, 1);
+    doc.addImage(graphics.companyLogoMeasureQuickLight, "JPEG", .25, 10, 2.15625, .5);
+
+    doc.setLineWidth(0.025);
+    doc.setDrawColor(0);
+    doc.setFillColor(242, 242, 242);
+    doc.rect(.125, 1.125, 2.667, 3, "F");
+    doc.rect(2.917, 1.125, 2.667, 3, "F");
+    doc.rect(5.709, 1.125, 2.667, 3, "F");
+    doc.rect(.125, 4.25, 4.0625, 3.375, "F");
+
+    doc.addImage(graphics.iconSunshine, "JPEG", .4585, 1.625, 2, 2);
+    doc.addImage(graphics.iconHouse, "JPEG", .4585, 1.625, 2, 2);
+    doc.addImage(graphics.iconInfo, "JPEG", .4585, 1.625, 2, 2);
+    doc.addImage(graphics.iconPerformance, "JPEG", .4585, 1.625, 2, 2);
+
+    doc.addImage(graphics.footerMeasureQuick, "JPEG", 0, 7.75, 8.5, 4.5);
+
+    doc.setFontSize(6.5);
+    doc.setFontStyle("bolditalic");
+    if (theme == "dark") doc.setTextColor(255, 255, 255);
+    disclaimer = doc.splitTextToSize(templates.disclaimer.toUpperCase(), 8);
+    doc.text(disclaimer, .125, 10.66);
+}
+
+function printHeaderData(reportName, techName, profilePicture, companyLogo) {
+    var x = 0;
+    var y = 0;
+    var w = 0;
+    var h = 0;
+    doc.text(reportName, 0.25, .75);
+    if (profilePicture) printProfilePicture(techName, profilePicture);
+    if (companyLogo) printCompanyLogo(companyLogo);
+}
+
+function printBodyData(geolocationMap) {
+    printSingleBodySection(templates.outdoorMeasurements, .25, 2.317, 1.55);
+    printSingleBodySection(templates.indoorMeasurements, 3.042, 5.109, 1.55);
+    printSingleBodySection(templates.systemInfo, 5.834, 7.9, 1.55);
+    printSingleBodySection(templates.performanceData, .25, 2, 4.455);
+    printMap(geolocationMap);
+}
+
+function printSingleBodySection(dataPoints, xLeft, xRight, y) {
+    var s = .2;
+    var dataPoint;
+    var val;
+    var units;
+    var text;
+    for (let key in dataPoints) {
+        dataPoint   = dataPoints[key];
+        val         = reportData.values[key];
+        units       = Array.isArray(dataPoint.units) ? `${dataPoint.units[0]} / ${dataPoint.units[1]}` : dataPoint.units;
+        text        = dataPoint.hasOwnProperty("secondaryValue") ? `${val} / ${reportData.values[dataPoint.secondaryValue]}` : val;
+        doc.text(`${dataPoint.label} (${units}):`, xLeft, y);
+        doc.text(val, alignRight(val, xRight, 8), y);
+        doc.addImage(reportData.rangeIcons[key], "JPEG", xRight, y, .2, .2);
+        doc.addImage(reportData.toolIcons[key], "JPEG", xRight, y, .2, .2);
+        y += s;
+    }
+}
+
+function printMap(geolocationMap) {
+    doc.addImage(geolocationMap, "JPEG", 4.3125, 4.25, 4.0625, 3.375);
+}
+
+function printProfilePicture(techName, profilePicture) {
+    var x = 0;
+    var y = 0;
+    var w = 0;
+    var h = 0;
+    doc.addImage(profilePicture, "JPEG", x, y, w, h);
+    doc.text(techName, x, y, w, h);
+}
+
+function printCompanyLogo(companyLogo) {
+    var x = 0;
+    var y = 0;
+    var w = 0;
+    var h = 0;
+    doc.addImage(companyLogo, "JPEG", x, y, w, h);
+}
+
+function printFooterData(techName, profilePicture, companyLogo) {
+    var x = 0;
+    var y = 0;
+    var w = 0;
+    var h = 0;
+    if (profilePicture) printProfilePicture(techName, profilePicture);
+    if (companyLogo) printCompanyLogo(companyLogo);
+
+    var s = .2;
+    var x = 0;
+    var y = 0;
+    templates.footerData.forEach(key => {
+        doc.text(reportData.values[key], x, y);
+        y += s;
+    });
+}
+
+function printPhotos(photoArray) {
+    for (let photo in photoArray) {
+
+    }
+}
+
+function printInfoPage(reportType) {
+    // doc.addPage();
+    if (reportType == "cooling") {
+        // Print info page on cooling subsystem diagnostics
+    } else if (reportType == "heating") {
+        // Print info page on heating subsystem diagnostics
+    }
+}
+
+function alignRight(text, rightAlign, fontSize) {
+    return rightAlign - doc.getStringUnitWidth(text) * fontSize / 72;
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@measurequick/measurequick-report-generator",
+  "version": "1.0.0",
+  "description": "Generates PDF documents for various MeasureQuick applications.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "jspdf": "^1.3.5"
+  },
+  "keywords": [
+    "measurequick"
+  ],
+  "author": "MeasureQuick",
+  "license": "ISC"
+}