luxtronik2
Version:
Reads and controls heat pumps based on the Luxtronik 2.0 contol unit. Supports for example AlphaInnotec and Siemens Novelan (WRP NET).
159 lines (123 loc) • 4.76 kB
Markdown
# Luxtronik2
Luxtronik2 reads and controls heat pumps based on the Luxtronik 2.0 contol unit with **Node.js**.
This work based on the fantastic [FHEM module 'LUXTRONIK2'](https://wiki.fhem.de/wiki/Luxtronik_2.0), the very usefull [openHAB binding 'Novelan Luxtronic heat pump'](
https://github.com/openhab/openhab1-addons/wiki/Novelan-Luxtronic-heat-pump-binding), the extensively [cbrandlehner/homebridge-luxtronik2](https://github.com/cbrandlehner/homebridge-luxtronik2) and a little bit research of my own. Hope you will like it.
**Supports the following heat pumps**
* Alpha Innotec
* Siemens Novelan (WPR NET)
* Roth (ThermoAura(r), ThermoTerra)
* Elco
* Buderus (Logamatic HMC20, HMC20 Z)
* Nibe (AP-AW10)
* Wolf Heiztechnik (BWL/BWS)
* CTA (Aeroheat AH CI 1-16iL)
## Status
| Category | Status |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Version | [](https://badge.fury.io/js/luxtronik2) |
| License | [](https://www.npmjs.com/package/luxtronik2) |
## Installation
```shell
npm install luxtronik2
```
## How to use
Connect your unit via lan and configure the ip parameters at your unit. The port number of your unit is 8888 by default.
Clone this code via git or simply via npm. You will get a package named luxtronik. You can require this at your code to
read and write to your heat pump.
## Examples
```javascript
var luxtronik = require('luxtronik2');
const hostIp = '127.0.0.1'; // <- Enter your Luxtronik IP here
var pump = new luxtronik.createConnection(hostIp, 8888);
// read all readable data
pump.read(function (err, data) {
if (err) {
return console.log(err);
}
console.log(data);
console.log(data.values.errors);
});
// set heating target temperature to 0 °C
pump.write('heating_target_temperature', 0);
// set warm water target temperature to 60 °C and use callback
pump.write('warmwater_target_temperature', 60, function (err, res) {
if (err) {
return console.log(err);
}
console.log(res);
});
// set heating operation mode to 'Auto'
pump.write('heating_operation_mode', 0);
// set warm water operation mode to 'Auto'
pump.write('warmwater_operation_mode', 0);
// set heating target temperature and use callback
pump.write('heating_target_temperature', 0, function (err, res) {
if (err) {
return console.log(err);
}
console.log(res);
});
```
### Ability to plug in to processing data
It is possible to plug in to data processing by passing third option into `createConnection` function (or Luxtronik constructor). See the example below:
```javascript
const pump = luxtronik.createConnection('192.168.0.190', 8889, {
onProcessValues: function (heatpumpValues, heatpumpVisibility) {
return {
additional_value: (heatpumpVisibility[24] === 1) ? heatpumpValues[13] / 10 : 'no',
};
},
onProcessParameters: function (heatpumpParameters, heatpumpVisibility) {
return {
additional_parameter: (heatpumpVisibility[207] === 1) ? heatpumpParameters[11] / 10 : 'no',
};
},
});
pump.read(function (err, data) {
if (err) {
return console.log(err);
}
console.log(data);
console.log(data.values.errors);
});
```
Output:
```javascript
{
values: {
additional_value: 'no',
// ...regular values
},
parameters: {
additional_parameter: 26.5,
// ...regular parameters
}
}
[
// ...errors will go here
]
```
### read/set runDearate
Note: you need to set "runDearate" directly after you set the related pump, otherwise the Lux will not start the pump!
Example code:
```javascript
const value= 1;
pump.write('solarPumpDeaerate', value, function (err, data) {
if (err) {
return console.log(err);
}
console.log(data);
console.log("done");
pump.write('runDeaerate', value, function (err, data) {
if (err) {
return console.log(err);
}
console.log(data);
console.log("done");
});
});
```
## Migrating to version 2.0.0
The API changed between version 1.0.3 and version 2.0.0. [See migrating guide](MIGRATING.md) for information on how to migrate your application to the new API.
## Migrating to version 1.0.0
The API changed between version 0.1.2 and version 1.0.0. [See migrating guide](MIGRATING.md) for information on how to migrate your application to the new API.