documentation

cityssm · Sep 20, 2023 · f5a903a · f5a903a
1 parent 9154eb9
commit f5a903a
Show file tree

Hide file tree

Showing 10 changed files with 63 additions and 12 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -14,7 +14,7 @@ Filter and view energy data in charts and tables.
 [**Assets**](assets.md)<br />
 Manage tracked assets. Create groups of assets for easier reporting.
 
-[**Data**](data.md)<br />
+[**Data Sources**](data.md)<br />
 Add new energy data from supporting input files.
 
 [**Reports**](reports.md)<br />

diff --git a/docs/assets.md b/docs/assets.md
@@ -4,4 +4,11 @@
 
 # Assets
 
-![Assets](images/assets.png)
+![Assets](images/assets.png)
+
+**Assets** describe any entity that consumes energy. Arenas, administrative buildings,
+and parks are all assets that may consume multiple energy types,
+like electricity, natural gas, and water. EMILE can track multiple energy types
+on each of the assets it tracks.
+
+**Asset Groups** are a way to group together assets for the purpose of reporting on them together.
diff --git a/docs/dashboard.md b/docs/dashboard.md
@@ -4,4 +4,16 @@
 
 # EMILE Dashboard
 
-![Dashboard](images/dashboard.png)
+![Dashboard](images/dashboard.png)
+
+EMILE provides limited charting options, filtered by:
+
+- Asset, Asset Category, or Asset Group.
+- Start Date.
+- End Date.
+
+The data for each chart can be exported using the corresponding "Export" button.
+
+Note that selecting a large number of assets and a large time range
+can cause performance issues.  For more complex reporting, it is recommended to export the data
+into a reporting application like Microsoft Excel or Microsoft Power BI.
diff --git a/docs/dataSources.md b/docs/dataSources.md
@@ -4,4 +4,36 @@
 
 # Data Sources
 
-![Data](images/data-pendingFiles.png)
+![Data Sources](images/data-pendingFiles.png)
+
+**Data Sources** are the places where energy data comes from.
+
+Uploaded data files can be the following types.
+
+- CSV files.
+- Microsoft Excel files.
+- [Green Button Download My Data® (DMD)](https://www.greenbuttonalliance.org/green-button-download-my-data-dmd) XML files.
+
+Only files with defined parsers can be uploaded.
+In the case of CSV and Excel files, those parsers are defined in EMILE's config file.
+
+![Data Subscriptions](images/data-subscriptions.png)
+
+EMILE also has the ability to receive data automatically using the
+[Green Button Connect My Data® (CMD)](https://www.greenbuttonalliance.org/green-button-connect-my-data-cmd) standard.
+
+⭐ Note that before EMILE can connect to your utility's servers,
+you need to go through a third party application registration process
+with the utility. Each utility provider has a unique registration
+process, but once registered, should function similarly.
+
+Tested Green Button® CMD implementations include:
+
+- [PUC Services provided through Utility API](https://greenbutton.ssmpuc.com/).
+
+For more information on tested implementations, see the
+[Green Button® Subscriber for Node repository](https://github.com/cityssm/node-green-button-subscriber).
+
+## Trademarks
+
+® GREEN BUTTON is a registered trademark owned by Departments of the U.S. Government.
diff --git a/docs/images/data-pendingFiles.png b/docs/images/data-pendingFiles.png
diff --git a/docs/images/data-subscriptions.png b/docs/images/data-subscriptions.png
diff --git a/public-typescript/adminDatabase.js b/public-typescript/adminDatabase.js
@@ -68,7 +68,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
             rowElement.dataset.fileName = backupFile.fileName;
             rowElement.innerHTML = `<td>${backupFile.fileName}</td>
         <td>${backupFile.lastModifiedTime}</td>
-        <td class="has-text-right">${backupFile.sizeInMegabytes} MB</td>
+        <td class="has-text-right">${backupFile.sizeInMegabytes.toFixed(2)} MB</td>
         <td>
           <div class="field is-grouped">
             <div class="control">

diff --git a/public-typescript/adminDatabase.ts b/public-typescript/adminDatabase.ts
@@ -98,7 +98,7 @@ declare const cityssm: cityssmGlobal
 
       rowElement.innerHTML = `<td>${backupFile.fileName}</td>
         <td>${backupFile.lastModifiedTime}</td>
-        <td class="has-text-right">${backupFile.sizeInMegabytes} MB</td>
+        <td class="has-text-right">${backupFile.sizeInMegabytes.toFixed(2)} MB</td>
         <td>
           <div class="field is-grouped">
             <div class="control">

diff --git a/public/javascripts/adminDatabase.min.js b/public/javascripts/adminDatabase.min.js
diff --git a/views/data.ejs b/views/data.ejs
@@ -90,7 +90,7 @@
   </div>
   <% if (Object.keys(greenButtonSubscriptions).length > 0) { %>
     <div class="tab-content is-hidden" id="tab--subscriptions">
-      <h2 class="title is-4">Green Button Connect My Data</h2>
+      <h2 class="title is-4">Green Button® Connect My Data</h2>
 
       <table class="table is-fullwidth is-striped is-fade-hoverable has-sticky-header">
         <thead>
@@ -139,11 +139,11 @@
 <%- include('_footerA'); -%>
 
 <script>
-  exports.Emile.assets = <%- JSON.stringify(assets) %>;
+  exports.Emile.assets = <%- JSON.stringify(assets ?? []) %>;
 
-  exports.pendingFiles = <%- JSON.stringify(pendingFiles) %>;
-  exports.processedFiles = <%- JSON.stringify(processedFiles) %>;
-  exports.parserClassesAndConfigurations = <%- JSON.stringify(parserClassesAndConfigurations) %>;
+  exports.pendingFiles = <%- JSON.stringify(pendingFiles ?? []) %>;
+  exports.processedFiles = <%- JSON.stringify(processedFiles ?? []) %>;
+  exports.parserClassesAndConfigurations = <%- JSON.stringify(parserClassesAndConfigurations ?? []) %>;
 </script>
 <script src="<%= urlPrefix %>/javascripts/data.min.js"></script>