vcontrol

0.0.8 • Public • Published

VControl

vcontrold client to connect to a running vcontrold service. The client can read data from the service by sending a get command or write data by sending a set command. The available commands can be obtained when connecting with telnet to the vcontrold service and send commands.

Details on how to set up the hard- and software to get a vcontrold server running can be found in the OpenV-Wiki.

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.

Installation

Install with npm

npm install --save vcontrol

Example

const VControl = require("vcontrol")
 
vControlC = new VControl({
  host: "localhost",
  port: 3002
  debug: true   // optional
})
 
await vControl.connect()
 
let data = await vControl.getData("getTempA")
await vControl.setData("setTimerZirkuMo", ["07:00", "09:00"])
 
await vControl.close()

I experienced that vcontrold blocks command execution if there are multiple open connections. It might be a good practice to close the connection when the command finished.

Package Sidebar

Install

npm i vcontrol

Weekly Downloads

7

Version

0.0.8

License

GPL-3.0

Unpacked Size

41.9 kB

Total Files

4

Last publish

Collaborators

  • nexx512