cityssm/emile

"Energy Monitoring in Less Effort" - An application to aggregate energy consumption data across several municipal assets and report usage to monitor and manage emissions. Makes bringing together Green Button and CSV data sources a breeze!

EMILE (Energy Monitoring in Less Effort)

Pronounced like Emily

An application to collect and aggregate energy consumption data across several municipal assets and report usage to monitor and manage emissions.

Makes bringing together Green Button® and CSV data sources a breeze!

Available Inputs

• ✔️ Green Button® formatted XML acquired manually through the Download My Data (DMD) standard.
• ✔️ CSV files.
• ✔️ Green Button® formatted XML acquired automatically through the Connect My Data (CMD) standard, compatible with:
  • UtilityAPI, namely their integration with PUC Distribution Inc.

Outputs, Exports, and Reports

• ✔️ Graphs.
• ✔️ CSV files.
• ✔️ Power Query compatible URLs for refreshable data in Microsoft Excel and Microsoft Power BI.
• ✔️ SQLite database file.
• ✏️ Energy Star Portfolio Manager data.
• ✏️ Partners for Climate Protection Milestone Tool data.

About this Project

📘 User Documentation (In The Works)

• 🤗 Code of Conduct
• 🥰 Contributing Guidelines
• 🛡️ Security Policy
• 📃 MIT Licence

Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to solve the same problems and move away from older, legacy systems.

It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh or upgrade their energy usage tracking.

More Projects from the City of Sault Ste. Marie

EMILE's energy usage monitoring is made possible using the City of Sault Ste. Marie's Green Button® Parser for Node and Green Button® Subscriber for Node.

The City of Sault Ste. Marie also has several other open source applications available for managing municipal operations.

• 💡 General Licence Manager - An application built to manage the general licences issued by municipalities.
• 💡 Lottery Licence Manager - An application for managing AGCO's municipal lottery licensing requirements in Ontario.

Browse our GitHub account for more of the City's offerings.

Trademarks

® GREEN BUTTON is a registered trademark owned by Departments of the U.S. Government.

The City of Sault Ste. Marie is a Liaison member of the Green Button Alliance.

emile's Issues

[FEATURE REQUEST] Support Enbridge's Green Button Implementation

What feature are you suggesting?

Support for Enbridge's upcoming Green Button Connect My Data Implementation.

Is your feature request related to a problem?

No.

Are there any workarounds? Are there any alternative solutions that would work?

Download the data manually for 30+ assets using Green Button Download My Data, and upload it into EMILE. Note that manually generated Green Button files from Enbridge are importing successfully, so node-green-button-parser should be ready.

Are there any other helpful details?

• 🛑 Enbridge's Third Party Application is not yet ready.

• ‼️ The requirements to become a third party are more extensive than PUC, based on Enbridge's FAQ page.

• 😩 The bulk download endpoint appears significantly more complicated compared to PUC. Rather than providing the data on request like PUC, Enbridge's solution requires a public facing notify URL to notify when data is ready to download over SFTP. Updates to node-green-button-subscriber will be required.

EnergyData table too large

After scaling up to over 150 polled assets, the EnergyData table is too large to poll. It needs to be split!

Ending Support For Node 14 and Node 16 in November 2023

More and more dependencies are dropping support for Node 14 and Node 16 since both versions have reached end-of-life.

In November 2023, this project will follow suit, stop testing against these older versions of Node, and fully embrace Node 18 and Node 20.

• Update engines block in package.json to >=18.0.0.
• Unblock dependency updates that discontinue support for Node 14 and Node 16.
• Remove helpers/polyfills as they are no longer needed.
• Update Node versions in coverage.yml.

Try optimizing file processing.

Parsing a 10MB xml file is pretty slow currently.

I don't have a good intuition for what part is slow. Do you think there might be some low hanging fruit here? Any hunches?

The first step would be profiling.