Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.42 KB

README.md

File metadata and controls

55 lines (37 loc) · 2.42 KB
Raw

Green Button® Parser for Node

npm (scoped) DeepSource Maintainability codecov

Parse Green Button® formatted energy consumption feeds into JSON.

Features

  • Fully typed output.
  • Support for Green Button® XML containing full feeds and single entries.
  • Enumerated values translated to meaningful text.
  • Helpful functions to link things together.

Important Note

This code is for use with the Green Button Download My Data® (DMD) standard, or with Green Button® formatted XML.

💡 If you are looking to subscribe to Green Button® data using the Green Button Connect My Data® (CMD) standard, see the City of Sault Ste. Marie's Green Button® Subscriber.

💡 If you are looking for a full application to report on energy usage, see EMILE (Energy Monitoring in Less Effort).

Installation

npm install @cityssm/green-button-parser

Usage

import { atomToGreenButtonJson } from '@cityssm/green-button-parser'

const greenButtonJson = await atomToGreenButtonJson('<feed> ... </feed>')

Helpful Links

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.