vitocollect
v0.0.8
Published
Collect data from vcontrold and store in Influx database
Downloads
39
Maintainers
Readme
VitoCollect
Collect data from VControlD periodically and store the collected data in an Influx database.
Disclaimer
You use this software at your own risk. I can not be held liable for anything that happens to your heating system, including any damage, by the use of this software.
Prerequisites
You need a running vcontrold server and an influx database. Details on how to set up the hard- and software to get a vcontrold server running can be found in the OpenV-Wiki.
Installation
Install with npm install -g vitocollect
if you want the app to be in your path
or npm install vitocollect
for a local installation in the current folder.
Copy <node_modules directory>/config/config.example.json
to
<node_modules directory>/vitocollect/config/config.json
and adjust to your
needs. For possible Influx configuration parameters refer to the
Influx API Documentation
except for the schema. The schema is generated by the job description in the
jobs.json
file. The database defined in the config must be created first. It
is not created automatically.
Copy <node_modules directory>/vitocollect/jobs.example.json
to
<node_modules directory>/vitocollect/jobs.json
and adjust to your needs.
Note that when updating the module the configuration files will be deleted. So make a backup of your config files beforehand.
Start
If installed globally, then you can start the application with
vitocollect
If you installed it locally, then start it with
./node_modules/.bin/vitocollect
If you need more output, you can enable debugging messages by settinge the
environment variable DEBUG
.