npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@robinrs/energy-storagejs

v0.0.2

Published

Interaction with energy storage systems from popular brands (/cgi/ems_data.js)

Downloads

8

Readme

energy-storagejs

npm version

energy-storagejs is a JavaScript library for accessing and retrieving data from energy storage systems. It provides an API for interacting with VARTA Storage Systems and retrieving battery-related information.

Installation

You can install energy-storagejs via npm:

npm install @robinrs/energy-storagejs

Usage

// Access API Class Object
const battery = energyStorage({
  ip: '192.168.2.130',
  fullRequest: '/cgi/ems_data.js',
  simpleRequest: '/cgi/ems_data.xml',
  paramsRequest: '/cgi/ems_conf.js',
  type: 'v', // Type for VARTA Storage Systems
});

// Request the data from the Battery
await battery.requestSimple();

// Data can now be accessed in raw format, to use the provided methods, parse the data
battery.parse();

Once parsed, the following methods can be used to retrieve battery information:

  • getTimeStamp(): Returns the timestamp of the data.
  • getState(): Returns the state of the battery.
  • getPercentageF(): Returns the battery percentage as a formatted value with the unit.
  • getPercentage(): Returns the battery percentage.
  • ... Check out the docs to see all methods

TODO

Please note that this package is still a work in progress. The following tasks are currently being worked on:

  • [] Add comments to further explain the code.
  • [] Implement the handler for more detailed requests.
  • [] Implement an interval to keep the data fresh.
  • [] Add support for more battery systems and companies.

Your contributions and feedback are welcome!

License

This project is licensed under the MIT License. See the LICENSE file for details.