https://github.com/fvdm/nodejs-toonapp
Eneco Toon module for node.js
https://github.com/fvdm/nodejs-toonapp
eneco-toon nodejs thermostat unlicense
Last synced: 3 months ago
JSON representation
Eneco Toon module for node.js
- Host: GitHub
- URL: https://github.com/fvdm/nodejs-toonapp
- Owner: fvdm
- License: unlicense
- Created: 2015-01-22T12:10:36.000Z (over 10 years ago)
- Default Branch: develop
- Last Pushed: 2021-07-19T10:18:50.000Z (over 4 years ago)
- Last Synced: 2025-07-05T14:59:20.561Z (4 months ago)
- Topics: eneco-toon, nodejs, thermostat, unlicense
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/toonapp
- Size: 68.4 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
toonapp
=======
Unofficial node.js module to interact with Eneco Toon thermostat.
[](https://github.com/fvdm/nodejs-toonapp/blob/master/CHANGELOG.md)
[](https://travis-ci.org/fvdm/nodejs-toonapp/branches)
[](https://coveralls.io/github/fvdm/nodejs-toonapp?branch=master)
[](https://www.bithound.io/github/fvdm/nodejs-toonapp/master/dependencies/npm)
[](https://www.bithound.io/github/fvdm/nodejs-toonapp/master/files)
[](https://greenkeeper.io/)
_Notice: this is not using the new official API, but instead the same endpoints as the iPhone app._
Example
-------
```js
// Set your Eneco account details
var toon = require ('toonapp') ({
username: 'your@email.tld',
password: 'account password'
});
// Set preset to Home
toon.setPreset (1, function (err, data) {
if (err) {
console.log (err);
return;
}
// OK, now get full status
toon.getState (console.log);
});
```
Installation
------------
`npm install toonapp`
Methods
-------
Each method requires a `callback` function to process the response data.
This function receives two arguments: `err` and `data`.
When something goes wrong `err` is an _Error_ and `data` is not available.
When all is good `err` is _null_ and `data` is the parsed response.
```js
function callback (err, data) {
if (err) {
console.log (err);
} else {
// process data
}
}
```
#### Errors
message | description | additional
:----------------|:----------------------------|:--------------------------------
api error | The API returned an error | `err.reason` and `err.errorCode`
invalid response | The API response was bad | `err.reason`
request failed | The request can not be made | `err.reason`
version
-------
**( callback )**
Get base version info.
param | type | required | description
:--------|:---------|:---------|:----------------------
callback | function | yes | Your callback function
```js
toon.version (console.log);
```
```js
{ hostUrl: 'https://toonopafstand.eneco.nl',
appVersion: '1.5',
minDisplayVersion: 'qb2/ene/2.2.0' }
```
setPreset
---------
**( preset, callback )**
Set Toon temperature to a preset.
param | type | required | description
:--------|:---------|:---------|:----------------------
preset | number | yes | Preset ID
callback | function | yes | Your callback function
```js
toon.setPreset (2, callback);
```
#### Presets
ID | label | additional
:--|:---------|:-----------------
0 | Comfort | See `getState() .thermostatStates`
1 | Thuis | " "
2 | Slapen | " "
3 | Weg | " "
4 | Vacation | Disables schedule
5 | - | unknown
setTemperature
--------------
**( value, callback )**
Set manual temperature, overriding scheduled preset until next program starts.
param | type | required | description
:--------|:---------|:---------|:------------------------------------------
value | number | yes | Celcius * 100, i.e. set `1845` for 18.45 C
callback | function | yes | Your callback function
```js
// 19.48 C, displayed as 19.5 on Toon
toon.setTemperature (1948, callback);
```
getState
--------
**( callback )**
Get current status information, statistics, readings, etc.
param | type | required | description
:--------|:---------|:---------|:----------------------
callback | function | yes | Your callback function
```js
toon.getState (function (err, data) {
if (err) { return console.log (err); }
// Current Watt/h from smart meter
if (data.powerUsage) {
console.log (data.powerUsage.value);
}
});
```
#### Short example
Sometimes you get only a short response like below, the output can vary a lot.
Most times the list is huge and for example `thermostatInfo` can be missing.
```js
{ success: true,
thermostatInfo:
{ currentTemp: 2010,
currentSetpoint: 2050,
currentDisplayTemp: 2050,
programState: 2,
activeState: 0,
nextProgram: 1,
nextState: 3,
nextTime: 1421940600,
nextSetpoint: 1600,
randomConfigId: 1804289383,
errorFound: 255,
zwaveOthermConnected: 0,
burnerInfo: '1',
otCommError: '0',
currentModulationLevel: 7,
haveOTBoiler: 1 },
thermostatStates:
{ state:
[ { id: 0, tempValue: 2050, dhw: 1 },
{ id: 1, tempValue: 1950, dhw: 1 },
{ id: 2, tempValue: 1700, dhw: 1 },
{ id: 3, tempValue: 1600, dhw: 1 },
{ id: 4, tempValue: 600, dhw: 0 },
{ id: 5, tempValue: 600, dhw: 1 } ] } }
```
Unlicense
---------
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to
Author
------
[Franklin van de Meent](https://frankl.in)
[](https://ko-fi.com/franklin)