$ ekoheat-boiler-parser

A parser and stats generator for EkoHeat Pellet Boilers.

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global ekoheat-boiler-parser

# Using yarn
yarn global add ekoheat-boiler-parser

Then, run ekoheat-boiler-parser --help and see what the CLI tool can do.

$ ekoheat-boiler-parser --help
Usage: ekoheat-boiler-parser <command> [options]

A parser and stats generator for EkoHeat Pellet Boilers.

Commands:
  download-current-frame   Download the current frame.
  extract-rectangles       Extract the rectangles from the frame.
  parse                    Parse the rectangles.
  save                     Parse the rectangles and save the output in the csv
                           file.
  stats                    Get the stats.
  keep-live-stream-active  Get the live stream.

Options:
  -c, --config <config>  The path to the config file (e.g. config.json).
  -h, --help             Displays this help.
  -v, --version          Displays version information.

Examples:
  $ ekoheat-boiler-parser extract-rectangles --config config.json
  $ ekoheat-boiler-parser parse --config config.json
  $ ekoheat-boiler-parser stats --config config.json

Documentation can be found at https://github.com/IonicaBizau/ekoheat-boiler-parser#readme.

I have installed an Android phone running DroidCam in front of the boiler screen. The phone streams the video through http and by using OCR technology I can extract the data from the boiler screen.

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău