RESOL-JSON

Live JSON data server for RESOL VBUS

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

Built With

• 
• 

(back to top)

Getting Started

In order to use this app you need a RESOL heat exchanger system with a VBus/Lan adapter. This small node application allows you to integrate your RESOL system into any home automation system like HomeAssistant with a bit of work.

Prerequisites

In order to use the application you need node.js and npm installed on your system OR you could user the provided Dockerfile to build a docker image.

Installation

1. Clone the repo

   git clone https://github.com/CoMPlest/resol-json.git

2. Install any dependencies with npm

   cd resol-json
   npm install

3. Edit the configuration file src/config.js

   const config = {
        httpPort: 3333,
        loggingInterval: 10000,
        loggingFilename: path.resolve(__dirname, 'live-data.json'), /* Here you can specify a live-data file */
        connectionClassName: 'TcpConnection',
        connectionOptions: {
            host: '<YOUR_VBUS_IP>',
            password: 'vbus', /* Default password should by vbus */
        }
    };

4. Start your application

   npm start

5. Go to http://localhost:3333/api/v1/live-data to see live data

(back to top)

Docker

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPLv3 License. See LICENSE.txt for more information.

(back to top)

Contact

AAron Szekelyhidi - [email protected]

Project Link: https://github.com/CoMPlest/resol-json

(back to top)